numbers_and_words icon indicating copy to clipboard operation
numbers_and_words copied to clipboard

Ideas to add new language information to README in more readable way.

Open kslazarev opened this issue 12 years ago • 7 comments

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.

kslazarev avatar Feb 07 '13 15:02 kslazarev

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.

kslazarev avatar Feb 07 '13 15:02 kslazarev

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

  • a quick description of the gem
  • list of the supported languages and mentioning that they have separate documentation (and they may support extra options)
  • examples in every language, but a bit more compact than currently. it's nice to showcase what is achievable, but this will only ever grow
  • the other parts: requirements, installation, license, bugs and contacts

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.

eLod avatar Feb 07 '13 19:02 eLod

I believe the list of languages and maybe 1 example should be in every single language, but everything else can be in English.

dblock avatar Feb 07 '13 20:02 dblock

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).

eLod avatar Feb 07 '13 20:02 eLod

+1 for a readme in each language

sorich87 avatar Feb 16 '13 19:02 sorich87

@kslazarev: Could you enable the Wikis for this repo?

jlduran avatar Jul 15 '17 16:07 jlduran

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?

dblock avatar Jul 17 '17 18:07 dblock