2013-06-26 19:07:07 +00:00
|
|
|
# [Learn X in Y minutes](http://learnxinyminutes.com)
|
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).
|
2015-10-09 14:27:06 +00:00
|
|
|
Make a new file, send a pull request, and if it passes master 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
|
|
|
|
2014-11-09 09:25:00 +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
|
|
|
|
2013-09-05 17:52:17 +00:00
|
|
|
**Please tag your issues pull requests with [language/lang-code] at the beginning**
|
2014-11-09 09:25:00 +00:00
|
|
|
**(e.g. [python/en] for English Python).** This will help everyone pick out things they
|
2013-09-05 17:52:17 +00:00
|
|
|
care about.
|
|
|
|
|
|
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.
|
|
|
|
|
|
2013-09-05 17:52:17 +00:00
|
|
|
### Style Guidelines
|
|
|
|
|
|
|
|
|
|
* **Keep lines under 80 chars**
|
|
|
|
|
* **Prefer example to exposition**
|
|
|
|
|
* **Eschew surplusage**
|
2014-11-09 09:25:00 +00:00
|
|
|
* **Use UTF-8**
|
2013-09-05 17:52:17 +00:00
|
|
|
|
|
|
|
|
Long version:
|
2013-08-19 16:14:02 +00:00
|
|
|
|
|
|
|
|
* Try to keep **line length in code blocks to 80 characters or fewer**, or they'll overflow
|
|
|
|
|
and look odd.
|
|
|
|
|
|
|
|
|
|
* Try to use as few words as possible. Code examples are preferred over exposition in all cases.
|
|
|
|
|
|
|
|
|
|
* We welcome newcomers, but the target audience for this site is programmers with some experience.
|
|
|
|
|
So, try to avoid explaining basic concepts except for those specific to the language in question,
|
2014-11-09 09:25:00 +00:00
|
|
|
to keep articles succinct and scannable. We all know how to use Google here.
|
2013-08-19 16:14:02 +00:00
|
|
|
|
2014-11-09 09:25:00 +00:00
|
|
|
* For translations (or English articles with non-ASCII characters), please make sure your file is
|
|
|
|
|
UTF-8 encoded, and try to leave out the byte-order-mark at the start of the file. (`:set nobomb` in Vim)
|
2013-08-19 16:14:02 +00:00
|
|
|
|
2013-09-05 17:52:17 +00:00
|
|
|
### Header configuration
|
2013-08-19 16:14:02 +00:00
|
|
|
|
2014-11-09 09:25:00 +00:00
|
|
|
The actual site uses Middleman to generate HTML files from these Markdown ones. Middleman, or at least
|
2013-08-19 16:14:02 +00:00
|
|
|
the custom scripts underpinning the site, required that some key information be defined in the header.
|
|
|
|
|
|
2014-11-09 09:25:00 +00:00
|
|
|
The following fields are necessary for English articles about programming languages:
|
2013-08-19 16:14:02 +00:00
|
|
|
|
|
|
|
|
* **language** The *programming language* in question
|
2014-11-09 09:25:00 +00:00
|
|
|
* **contributors** A list of [author, URL] lists to credit
|
2013-08-19 16:14:02 +00:00
|
|
|
|
|
|
|
|
Other fields:
|
|
|
|
|
|
|
|
|
|
* **filename**: The filename for this article's code. It will be fetched, mashed together, and made downloadable.
|
2014-11-09 09:25:00 +00:00
|
|
|
For non-English articles, *filename* should have a language-specific suffix.
|
2013-08-19 16:14:02 +00:00
|
|
|
* **lang**: For translations, the human language this article is in. For categorization, mostly.
|
2013-06-26 19:06:34 +00:00
|
|
|
|
2014-11-09 09:25:00 +00:00
|
|
|
Here's an example header for an Esperanto translation of Ruby:
|
2013-09-05 17:52:17 +00:00
|
|
|
|
|
|
|
|
```yaml
|
|
|
|
|
---
|
|
|
|
|
language: ruby
|
|
|
|
|
filename: learnruby-epo.ruby
|
|
|
|
|
contributors:
|
|
|
|
|
- ["Doktor Esperanto", "http://example.com/"]
|
|
|
|
|
- ["Someone else", "http://someoneelseswebsite.com/"]
|
|
|
|
|
lang: ep-ep
|
|
|
|
|
---
|
|
|
|
|
```
|
|
|
|
|
|
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
|
|
|
|
|
[Creative Commons Attribution-ShareAlike 3.0 Unported](http://creativecommons.org/licenses/by-sa/3.0/deed.en_US)
|
|
|
|
|
licensing included on each doc page.
|
|
|
|
|
|
|
|
|
|
Anything not covered by the above -- basically, this README -- you can use
|
|
|
|
|
as you wish, I guess.
|
