Skip to content

Commit

Permalink
Merge pull request #165 from eastman81/patch-2
Browse files Browse the repository at this point in the history
Edited some spacing and capitalization
  • Loading branch information
jancborchardt committed Oct 24, 2017
2 parents 716dd57 + 457f2b9 commit afff9b3
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,17 @@
* **web-based & hosted** and with a gratis plan
* **usable** easy to use for everyone

Collecting them makes it easy to find available projects to use and contribute to – both users and developers profit from that. Everyone can help improve these services, not only by coding or translating but also by using and spreading the word.
Collecting them makes it easy to find available projects to use and contribute to – both users and developers profit from that. Everyone can help improve these services, not only by coding or translating but also by using and spreading the word.

Not every project will be listed here, especially not complicated ones. It’s not about giving many choices, it’s about providing the best solutions.
Not every project will be listed here, especially not complicated ones. It’s not about giving many choices, it’s about providing the best solutions.

## Adding new projects

When adding new projects, please consider the following guideline:

* Editing the file `js/data.json`
* Add project alphabetically within its category
* Add new line like: ` {"id":"PROJECTNAME","category":"..","name":"..","description":"..","address":"https://..","licenses":["..", ..],"tags":["..", ..],"alternative":["..", ..],"introduction":"..","source":"https://.."},`
* Add new line like: ` {"id":"PROJECTNAME","category":"..","name":"..","description":"..","address":"https://..","licenses":["..", ..],"tags":["..", ..],"alternative":["..", ..],"introduction":"..","source":"https://.."},`
* `id`, `category`, `name`, `description`, `address`, `licenses`, `introduction`, `source` are mandatory
* For `category`, `licenses` and `alternative`, use names defined in (same) `js/data.json` at the top
* If the corresponding name isn't defined yet, just add it in the same commmit
Expand All @@ -26,13 +26,13 @@ When adding new projects, please consider the following guideline:
* Even if there's no logo image provided by the project, a meaningful logo image is necessary, as there's no fall-back feature.
* You can at least take a screenshot of the project name, if there's a nicely styled website with specific fonts and colors.
* Ideal size is 160 px×160 px and never bigger
* (Near-)quadratic or round logos (and everything in-between) shall be best resized to 128 px×128 px and centered in a 160 px×160 px canvas
* (Near-) quadratic or round logos (and everything in-between) shall be best resized to 128 px×128 px and centered in a 160 px×160 px canvas
* Sparse (mostly transparent, e. g. letters) logos shall be best resized to the maximum size that fits in 160 px×160 px
* If the logo is very lengthy (like ratio > 3:1), you can consider:
* cutting off the letters and just taking the figure in the logo
* cutting the text apart where appropriate and wrapping around
* Cutting off the letters and just taking the figure in the logo
* Cutting the text apart where appropriate and wrapping around
* One commit message for a new project (so that the history remains slim and esp. the rss feed is kept nice)
* Don't mix irrelevant changes in the commit, but just add the necessary things for the new project
* First line of commit message: `New project: PROJECTNAME #THE_CORRESPONDING_ISSUE` (additional notes can be added as appropriate)
* optionally write more details in the following lines (source etc.)
* Optionally write more details in the following lines (source etc.)

0 comments on commit afff9b3

Please sign in to comment.