Coder Social home page Coder Social logo

Comments (7)

kslazarev avatar kslazarev commented on August 31, 2024

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.

from numbers_and_words.

eLod avatar eLod commented on August 31, 2024

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.

from numbers_and_words.

dblock avatar dblock commented on August 31, 2024

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

from numbers_and_words.

eLod avatar eLod commented on August 31, 2024

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

from numbers_and_words.

sorich87 avatar sorich87 commented on August 31, 2024

+1 for a readme in each language

from numbers_and_words.

jlduran avatar jlduran commented on August 31, 2024

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

from numbers_and_words.

dblock avatar dblock commented on August 31, 2024

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?

from numbers_and_words.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.