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…

Что это такое?Набор краткосправочных руководств по многим языкам программирования. Каждое написано как один корректный исходный файл с комментариями, который объясняет язык так, как он работает.
Это одно руководство или целый каталог руководств по языкам?Это каталог: отдельный самостоятельный документ на каждый язык (иногда на каждую тему), а не одна книга или курс, который нужно проходить по порядку.
Как этим пользоваться?Просто откройте файл нужного языка и читайте код с комментариями сверху вниз. Для использования документов ничего устанавливать не нужно.
Все ли руководства по языкам одинаково полные и актуальные?Полнота целиком зависит от изменений, присланных сообществом через pull request, поэтому глубина и актуальность различаются от файла к файлу: одни подробные, другие короче и представляют собой заготовки.
Можно ли отправить перевод существующего руководства?Да, переводы на любой язык приветствуются. Добавьте в начало задачи (issue) или pull request тег языка и кода языка, например [python/en], чтобы мейнтейнеры могли его найти.
Почему структура построена как код, а не как текст?Вся идея проекта в том, чтобы учить язык «как код»: сам документ является корректным исполняемым исходником с комментариями внутри, а не статьёй в прозе.
Creator
adambard
Size
30.9 MB
Stars
12.4K
Updated
CommitSep 21
Age
13y
Commits · 90 Days