-
Notifications
You must be signed in to change notification settings - Fork 115
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Ideas to add new language information to README in more readable way. #48
Comments
I like that there are instructions for every language, but sometimes want to remove unnecessary information, maybe README file for each language with links or wiki could be a nice approach. |
I think the instructions in multiple languages is a nice addition, however as you mention the readme would quickly become a mess if it would include all the translations for every supported language (not to mention other problems, like hungarian is a highly inflected language, so you can't simply replace "compatible with" with the exact hungarian translation in "compatible with Ruby 1.9" because that wouldn't adhere to our grammar rules). I think the readme should only include
and only in english, further localized documentation should kept as separate not to clutter the readme. As languages will grow to have specific options it will make sense to move the documentation of these options to the documentation of the related languages (that support these options). I'm not sure which format is better, the GH wiki is a convenient place, however with separate files (committed to the repo) the gem documentation could also include these. |
I believe the list of languages and maybe 1 example should be in every single language, but everything else can be in English. |
maybe we could have a few examples only in english (e.g. how to use the gem), but before that we could have a few numbers (possibly including fractional and other specific things to showcase) translated as the array example right now (e.g. a more terse translation of multiple numbers). |
+1 for a readme in each language |
@kslazarev: Could you enable the Wikis for this repo? |
Wikis tend to quickly become obsolete and changes are free-for-all. Can we just add .md files to the repo in pull requests and link in READMEs? |
Problem: It looks like a mess when there are more than 3 languages in README headings.
Maybe someone @dblock , @Shk-Serji, @sorich87, @eLod could generate an idea with this deal.
The text was updated successfully, but these errors were encountered: