From c4caaf42aab215e642f1212befb18f288511b542 Mon Sep 17 00:00:00 2001 From: Eran Medan Date: Fri, 9 Aug 2013 14:58:39 -0400 Subject: Updated most requested languages :) --- README.markdown | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) (limited to 'README.markdown') diff --git a/README.markdown b/README.markdown index 77e09abd..efc2fa07 100644 --- a/README.markdown +++ b/README.markdown @@ -16,8 +16,9 @@ properly! The most requested languages are: -* Scala -* Javascript +* Go +* ~~Scala~~ +* ~~Javascript~~ ... but there are many more requests to do "every language", so don't let that stop you. -- cgit v1.2.3 From f33dea8b83bf64ecde36337a5e02cae77f5210de Mon Sep 17 00:00:00 2001 From: Adam Date: Mon, 19 Aug 2013 09:14:02 -0700 Subject: Updates --- README.markdown | 41 +++++++++++++++++++++++++++++++++++------ 1 file changed, 35 insertions(+), 6 deletions(-) (limited to 'README.markdown') diff --git a/README.markdown b/README.markdown index efc2fa07..701b12d7 100644 --- a/README.markdown +++ b/README.markdown @@ -9,18 +9,47 @@ commented code and explained as they go. ... 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 author and author\_url fields so you get credited +Remember to fill in the "contributors" fields so you get credited properly! ### Requests -The most requested languages are: +We've had a ton of interest, b -* Go -* ~~Scala~~ -* ~~Javascript~~ +### Contributing -... but there are many more requests to do "every language", so don't let that stop you. +All contributions 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). + +#### Style Guidelines + +* 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, + to keep articles succinct and scannable. We all know how to use google here. + +* For translations (or english articles with non-ASCII characters), please make sure your file is + utf-8 encoded. + +#### Header configuration + +The actual site uses Middleman to generate HTML files from these markdown ones. Middleman, or at least +the custom scripts underpinning the site, required that some key information be defined in the header. + +The following fields are necessary for english articles about programming languages: + +* **language** The *programming language* in question +* **contributors** A list of [author, url] lists to credit + +Other fields: + +* **filename**: The filename for this article's code. It will be fetched, mashed together, and made downloadable. + For non-english articles, *filename* should have a language-specific suffix. +* **lang**: For translations, the human language this article is in. For categorization, mostly. ## License -- cgit v1.2.3 From fc2757a87f7f3850624069a3254ba4175a2e4aff Mon Sep 17 00:00:00 2001 From: Adam Date: Tue, 20 Aug 2013 08:57:08 -0700 Subject: Fixes --- README.markdown | 4 ---- 1 file changed, 4 deletions(-) (limited to 'README.markdown') diff --git a/README.markdown b/README.markdown index 701b12d7..fe72df6c 100644 --- a/README.markdown +++ b/README.markdown @@ -12,10 +12,6 @@ Make a new file, send a pull request, and if it passes muster I'll get it up pro Remember to fill in the "contributors" fields so you get credited properly! -### Requests - -We've had a ton of interest, b - ### Contributing All contributions welcome, from the tiniest typo to a brand new article. Translations -- cgit v1.2.3 From 5a87423e209ee77b53e20f70ccc87c26511c4869 Mon Sep 17 00:00:00 2001 From: Adam Bard Date: Thu, 5 Sep 2013 10:52:17 -0700 Subject: Update README.markdown --- README.markdown | 33 +++++++++++++++++++++++++++++---- 1 file changed, 29 insertions(+), 4 deletions(-) (limited to 'README.markdown') diff --git a/README.markdown b/README.markdown index fe72df6c..dc379a9b 100644 --- a/README.markdown +++ b/README.markdown @@ -12,12 +12,24 @@ Make a new file, send a pull request, and if it passes muster I'll get it up pro Remember to fill in the "contributors" fields so you get credited properly! -### Contributing +## Contributing All contributions 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. -#### Style Guidelines +**Please tag your issues pull requests with [language/lang-code] at the beginning** +**(e.g. [python/en] for english python).** This will help everyone pick out things they +care about. + +### Style Guidelines + +* **Keep lines under 80 chars** +* **Prefer example to exposition** +* **Eschew surplusage** +* **Use utf-8** + +Long version: * Try to keep **line length in code blocks to 80 characters or fewer**, or they'll overflow and look odd. @@ -29,9 +41,9 @@ in all languages are welcome (or, for that matter, original articles in any lang to keep articles succinct and scannable. We all know how to use google here. * For translations (or english articles with non-ASCII characters), please make sure your file is - utf-8 encoded. + utf-8 encoded, and try to leave out the byte-order-mark at the start of the file. (`:set nobomb` in vim) -#### Header configuration +### Header configuration The actual site uses Middleman to generate HTML files from these markdown ones. Middleman, or at least the custom scripts underpinning the site, required that some key information be defined in the header. @@ -47,6 +59,19 @@ Other fields: For non-english articles, *filename* should have a language-specific suffix. * **lang**: For translations, the human language this article is in. For categorization, mostly. +Here's an example header for an esperanto translation of Ruby: + +```yaml +--- +language: ruby +filename: learnruby-epo.ruby +contributors: + - ["Doktor Esperanto", "http://example.com/"] + - ["Someone else", "http://someoneelseswebsite.com/"] +lang: ep-ep +--- +``` + ## License Contributors retain copyright to their work, and can request removal at any time. -- cgit v1.2.3 From e3c13dd8ce6166b69e8085caea11da963d215d74 Mon Sep 17 00:00:00 2001 From: Peter Mortensen Date: Sun, 9 Nov 2014 10:25:00 +0100 Subject: Update README.markdown Copy edited (e.g. ref. , , , http://en.wikipedia.org/wiki/Python_%28programming_language%29, , and ). --- README.markdown | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) (limited to 'README.markdown') diff --git a/README.markdown b/README.markdown index dc379a9b..4e24bbe6 100644 --- a/README.markdown +++ b/README.markdown @@ -14,12 +14,12 @@ properly! ## Contributing -All contributions welcome, from the tiniest typo to a brand new article. Translations +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 tag your issues pull requests with [language/lang-code] at the beginning** -**(e.g. [python/en] for english python).** This will help everyone pick out things they +**(e.g. [python/en] for English Python).** This will help everyone pick out things they care about. ### Style Guidelines @@ -27,7 +27,7 @@ care about. * **Keep lines under 80 chars** * **Prefer example to exposition** * **Eschew surplusage** -* **Use utf-8** +* **Use UTF-8** Long version: @@ -38,28 +38,28 @@ Long version: * 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, - to keep articles succinct and scannable. We all know how to use google here. + to keep articles succinct and scannable. We all know how to use Google here. -* 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) +* 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) ### Header configuration -The actual site uses Middleman to generate HTML files from these markdown ones. Middleman, or at least +The actual site uses Middleman to generate HTML files from these Markdown ones. Middleman, or at least the custom scripts underpinning the site, required that some key information be defined in the header. -The following fields are necessary for english articles about programming languages: +The following fields are necessary for English articles about programming languages: * **language** The *programming language* in question -* **contributors** A list of [author, url] lists to credit +* **contributors** A list of [author, URL] lists to credit Other fields: * **filename**: The filename for this article's code. It will be fetched, mashed together, and made downloadable. - For non-english articles, *filename* should have a language-specific suffix. + For non-English articles, *filename* should have a language-specific suffix. * **lang**: For translations, the human language this article is in. For categorization, mostly. -Here's an example header for an esperanto translation of Ruby: +Here's an example header for an Esperanto translation of Ruby: ```yaml --- -- cgit v1.2.3 From 658c09f6e4263e834153907cca87df00e4d9ab3b Mon Sep 17 00:00:00 2001 From: Adam Bard Date: Mon, 8 Dec 2014 23:42:24 +0100 Subject: Update README.markdown --- README.markdown | 5 +++++ 1 file changed, 5 insertions(+) (limited to 'README.markdown') diff --git a/README.markdown b/README.markdown index 4e24bbe6..774797d5 100644 --- a/README.markdown +++ b/README.markdown @@ -22,6 +22,11 @@ Send a pull request or open an issue any time of day or night. **(e.g. [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. + ### Style Guidelines * **Keep lines under 80 chars** -- cgit v1.2.3