learnxinyminutes-docs README

The project's README from github.com/adambard/learnxinyminutes-docs. As one markdown file: README.md.

Learn X in Y minutes

Whirlwind tours of (several, hopefully many someday) popular and ought-to-be-more-popular programming languages, presented as valid, commented code and explained as they go.

We need YOU!...

... to write more inline code tutorials. Just grab an existing file from this repo and copy the formatting (don't worry, it's all very simple). Make a new file, send a pull request, and if it passes muster I'll get it up pronto. Remember to fill in the "contributors" fields so you get credited properly!

Contributing

All contributions are welcome, from the tiniest typo to a brand new article. Translations in all languages are welcome (or, for that matter, original articles in any language). Send a pull request or open an issue any time of day or night.

Please prepend the tag [language/lang-code] to your issues and pull requests. For example, [python/en] for English Python. This will help everyone pick out things they care about.

We're happy for any contribution in any form, but if you're making more than one major change (i.e. translations for two different languages) it would be super cool of you to make a separate pull request for each one so that someone can review them more effectively and/or individually.

For a detailed style guide, please review the full CONTRIBUTING guidelines.

License

Contributors retain copyright to their work, and can request removal at any time. By uploading a doc here, you agree to publish your work under the default Creative Commons Attribution-ShareAlike 3.0 Unported licensing included on each doc page.

Anything not covered by the above -- basically, this README -- you can use as you wish, I guess.

learnxinyminutes-docs (adambard/learnxinyminutes-docs)

Searching Database…

What is this?A collection of quick-reference tutorials for many programming languages, each written as a single valid, commented source file that explains the language as it runs.
Is this one tutorial or a whole index of language guides?It's an index: one self-contained doc per language (sometimes per topic), not a single book or course you work through in order.
How do I actually use this?Just open the file for the language you want and read the commented code top to bottom; there's nothing to install to use the docs.
Is every language guide equally complete and up to date?Coverage depends entirely on community pull requests, so depth and freshness vary from one language file to another; some are detailed, others are shorter stubs.
Can I submit a translation of an existing guide?Yes, translations into any language are welcome; prepend the language/lang-code tag (e.g. [python/en]) to your issue or pull request so maintainers can find it.
Why is it structured as code instead of prose?The whole point of the project is to teach a language 'as code': the doc itself is valid, runnable source with inline comments instead of a prose article.
Creator
adambard
Size
30.9 MB
Stars
12.4K
Updated
CommitSep 21
Age
13y
Commits · 90 Days