learnxinyminutes-docs/README.markdown

45 lines
1.9 KiB
Markdown
Raw Normal View History

2015-10-23 18:25:42 +00:00
# [Learn X in Y minutes][1]
2013-06-26 17:58:50 +00:00
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.
2013-08-19 16:14:02 +00:00
Remember to fill in the "contributors" fields so you get credited
2013-06-26 17:58:50 +00:00
properly!
2013-09-05 17:52:17 +00:00
## Contributing
2013-06-26 19:06:34 +00:00
All contributions are welcome, from the tiniest typo to a brand new article. Translations
2013-08-19 16:14:02 +00:00
in all languages are welcome (or, for that matter, original articles in any language).
2013-09-05 17:52:17 +00:00
Send a pull request or open an issue any time of day or night.
2013-08-19 16:14:02 +00:00
2015-10-23 18:25:42 +00:00
**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.
2013-09-05 17:52:17 +00:00
2014-12-08 22:42:24 +00:00
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.
2015-10-23 18:25:42 +00:00
For a detailed style guide, please review the full [CONTRIBUTING][2] guidelines.
2013-09-05 17:52:17 +00:00
2013-06-26 18:35:04 +00:00
## License
2013-06-26 17:58:50 +00:00
2013-06-27 05:58:48 +00:00
Contributors retain copyright to their work, and can request removal at any time.
2013-06-26 18:35:04 +00:00
By uploading a doc here, you agree to publish your work under the default
2015-10-23 18:25:42 +00:00
[Creative Commons Attribution-ShareAlike 3.0 Unported][3]
2013-06-26 18:35:04 +00:00
licensing included on each doc page.
Anything not covered by the above -- basically, this README -- you can use
as you wish, I guess.
2015-10-23 18:25:42 +00:00
[1]: http://learnxinyminutes.com
[2]: https://github.com/adambard/learnxinyminutes-docs/blob/master/CONTRIBUTING.markdown
[3]: http://creativecommons.org/licenses/by-sa/3.0/deed.en_US