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…

这是什么?这是一个收集了众多编程语言速查教程的项目。每个教程都是一份语法正确、带注释的源代码文件,边看代码边了解该语言的实际运行方式。
这是一份教程,还是一整套语言指南的索引?它是一个索引:每种语言(有时是每个主题)各有一份独立的文档,而不是需要按顺序学习的整本书或课程。
我到底该怎么使用它?直接打开你想学的语言对应的文件,从上到下阅读带注释的代码即可;使用这些文档无需安装任何东西。
每种语言的指南都同样完整、及时更新吗?内容完全依赖社区提交的拉取请求(PR),因此每个语言文件的深度和更新程度各不相同;有些很详细,有些只是较短的草稿。
我可以提交现有指南的翻译版本吗?可以,欢迎提交任何语言的翻译。请在你的 Issue 或 Pull Request 标题前加上语言标签(格式为 语言/语言代码,例如 [python/en]),方便维护者找到。
为什么要以代码而不是文字的形式来组织内容?这个项目的核心目标就是以“代码”的方式讲授一门语言:文档本身就是语法正确、可运行的源代码,用行内注释代替传统的散文式文章。
Creator
adambard
Size
30.9 MB
Stars
12.4K
Updated
CommitSep 21
Age
13y
Commits · 90 Days