Project-OSRM / osrm-text-instructions

Text instructions from OSRM route responses
BSD 2-Clause "Simplified" License
87 stars 61 forks source link

Rewrite documentation #227

Closed 1ec5 closed 6 years ago

1ec5 commented 6 years ago

Added a guide to contributing to this project, as well as documentation on the abbreviation file format. Moved the grammar file documentation to the grammar folder. Rewrote large sections of the readme, relegating some content to other Markdown documents, and renamed the file for consistency.

/cc @lyzidiamond @danpaz

1ec5 commented 6 years ago

my once concern with it is that it's quite verbose -- as this page is meant for folks who speak all sorts of languages, maybe we can simplify the language down a bit? Things like "the issue may lie in" are not super translatable if you're not familiar with English colloquialisms.

Good point. I tried breaking up the prose a bit with more lists in 4e7c30a51471a5005c3755a25157ffda19639033. The more verbose language can be an impediment for speakers of English as a second language, so I tried to tone things down a little bit. I did leave some more precise language, hoping that a machine translation tool like Google Translate would yield better results that way. For example, “via UPDATE=1 npm test” is now “by running UPDATE=1 npm test”.

If you see more specific passages that are difficult to understand, please point them out via comments or feel free to edit them yourself. Thanks!