iskm/learnxinyminutes-docs
1
0
Fork 0
mirror of https://github.com/adambard/learnxinyminutes-docs.git synced 2024-12-23 09:41:36 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
Code documentation written as code! How novel and totally my idea!
8,445 Commits 3 Branches 0 Tags 50 MiB
Markdown 100%
99ddf8fec6
Go to file
awschult002 99ddf8fec6
[c/en] mostly word clarification and extra descriptions (#4222) 
* Adds extra clarity to enum value assignment.

The previous statement shows only 1 way to declare enums, and it happens
that they specify a starting value. I clarify that a starting value is
not necessary and that all enum value could contain user specified
values.

* Added clarity to `includes` section.

specified that angle brackets are for system libraries and not just
standard libs. I also added an example of relative paths in the local
include statements.

* Added more clarity for function prototyping and main return vals.

I cleaned up some formatting; then added some clarity to how function
prototyping works, as well as recommend techniques.

* Fixed the mention of character sizes. they are not always 1 byte

* Added clarity about floating point arithmetic.

The previous comments on floating points made it feel like there was
something broken with doing comparison and arithmetics with floating
point types. I added clarity about how floats are stored in memory and
why they seem to behave strangly when used in arithmetic expressions.

* reworded boolean stuff for better clarity on _Bool type in C99

* Adds not about binary assignment

* Added clarity for value roll over

* Added section on multiple return values.

C doesnt allow returning of multiple values, so i added a section on
returning multiple values through pointers.

* added section break for printing special characters

* fix typo

Co-authored-by: Andre Polykanine <ap@oire.me>

* fix typos

Co-authored-by: Andre Polykanine <ap@oire.me>

* fix markdown syntax

Co-authored-by: Andre Polykanine <ap@oire.me>

* fix markdown syntax

Co-authored-by: Andre Polykanine <ap@oire.me>

* fix markdown syntax

Co-authored-by: Andre Polykanine <ap@oire.me>

* reword with better english

Co-authored-by: Andre Polykanine <ap@oire.me>

* reword with better english

Co-authored-by: Andre Polykanine <ap@oire.me>

Co-authored-by: Andre Polykanine <ap@oire.me>
2021-08-24 21:57:49 +02:00
.github CODEOWNERS: add imba-tjd 2021-08-09 18:31:48 +08:00
ar-ar Python 3: Use 'filename: learnpython*.py' (no '3') 2020-02-12 07:04:42 +01:00
bg-bg Perl6 to Raku and many more 2020-06-10 16:33:01 +05:45
ca-es Fix filename 2019-09-22 23:33:55 +05:30
cs-cz Fix bad description of floor division 2020-02-19 10:04:30 +01:00
de-de [ruby/all] Replace tryruby.org with the proper link (#4217) 2021-08-21 23:08:42 +02:00
el-gr Fix #4211 2021-08-22 11:17:35 +02:00
es-es Rename OS X to macOS (#4166) 2021-05-25 13:42:50 +02:00
fa-ir Purge my deadname 2020-02-13 10:38:29 +10:30
fi-fi [ruby/all] Replace tryruby.org with the proper link (#4217) 2021-08-21 23:08:42 +02:00
fr-fr [set-theory/fr] Added French translation for Set theory (#4168) 2021-07-11 16:28:54 +02:00
hd-hd Added Hindi translation of JSON.html.markdown 2021-02-26 11:56:07 +05:30
hu-hu Merge pull request #3856 from sshine/make-python3-default 2020-02-13 22:00:05 -08:00
id-id [ruby/all] Replace tryruby.org with the proper link (#4217) 2021-08-21 23:08:42 +02:00
images/solidity updated solidity version, rng, and oracle documentation 2021-02-26 13:58:26 -05:00
it-it [ruby/all] Replace tryruby.org with the proper link (#4217) 2021-08-21 23:08:42 +02:00
ja-jp [vim/ja] Fix mistake 2021-04-16 08:24:34 +09:00
ko-kr Update vim-kr.html.markdown 2020-05-26 18:45:43 -07:00
lsf Fix line length 2019-11-01 13:52:16 +01:00
lt-lt Add language code suffix(#2832) 2017-08-25 13:50:47 +05:45
ms-my Rename OS X to macOS (#4166) 2021-05-25 13:42:50 +02:00
nl-nl Rename OS X to macOS (#4166) 2021-05-25 13:42:50 +02:00
no-nb Rename OS X to macOS (#4166) 2021-05-25 13:42:50 +02:00
pl-pl Perl6 to Raku and many more 2020-06-10 16:33:01 +05:45
pt-br Rename OS X to macOS (#4166) 2021-05-25 13:42:50 +02:00
pt-pt Rename OS X to macOS (#4166) 2021-05-25 13:42:50 +02:00
ro-ro Rename OS X to macOS (#4166) 2021-05-25 13:42:50 +02:00
ru-ru Rename OS X to macOS (#4166) 2021-05-25 13:42:50 +02:00
sk-sk Rename OS X to macOS (#4166) 2021-05-25 13:42:50 +02:00
sl-si Add Slovenian translation for AsciiDoc 2018-12-14 18:39:08 +01:00
sv-se Unify Further Reading 2021-03-10 21:16:16 -08:00
ta_in Purge my deadname 2020-02-13 10:38:29 +10:30
tests Reinstate test 2018-08-30 19:10:56 -07:00
th-th Fix outdated comment in en/th-th typescript docs 2019-10-22 13:16:52 +01:00
tr-tr Merge pull request #4007 from LeaveNhA/ruby/tr-tr 2020-09-05 18:15:20 -07:00
uk-ua [c/uk-ua] Add ukrainian translation for Clang (#3762) 2021-08-22 21:30:29 +02:00
vi-vn Rename OS X to macOS (#4166) 2021-05-25 13:42:50 +02:00
zh-cn [ruby/all] Replace tryruby.org with the proper link (#4217) 2021-08-21 23:08:42 +02:00
zh-tw Merge pull request #3948 from perltaiwan/zh-tw-translation 2021-08-08 13:27:34 +08:00
.gitattributes Perl6 to Raku and many more 2020-06-10 16:33:01 +05:45
.gitignore Updated, referencing #2185 2016-03-14 12:38:47 +05:30
.mailmap Purge my deadname 2020-02-13 10:38:29 +10:30
.travis.yml Add support for checking YAML validity using Travis CI 2016-11-09 18:06:38 -08:00
amd.html.markdown removing whitespace all over 2015-10-07 23:11:24 -04:00
angularjs.html.markdown Update angularjs.html.markdown 2017-08-18 06:27:04 +02:00
ansible.html.markdown [ansible/en]: Fix URL link 2020-01-24 16:06:32 +01:00
asciidoc.html.markdown [asciidoc/en][asciidoc/de][asciidoc/is][asciidoc/pt] fixed wrong 2017-09-21 18:57:11 +02:00
asymptotic-notation.html.markdown Some grammar, vocabulary, stylistic changes 2020-02-27 14:58:17 -05:00
awk.html.markdown add link to dubiousjim/awkenough Awk utility routines 2019-04-23 11:32:50 +00:00
bash.html.markdown [bash/en] Update bash.html.markdown (#4202) 2021-08-22 20:15:03 +02:00
bc.html.markdown [bc/en] New tutorial (#3519) 2019-08-01 16:45:11 +05:30
bf.html.markdown Update bf.html.markdown 2018-03-14 08:40:50 +05:45
c.html.markdown [c/en] mostly word clarification and extra descriptions (#4222) 2021-08-24 21:57:49 +02:00
c++.html.markdown Update c++.html.markdown 2021-01-31 21:55:38 +01:00
chapel.html.markdown Rename OS X to macOS (#4166) 2021-05-25 13:42:50 +02:00
CHICKEN.html.markdown Fix #3058 2018-02-28 17:01:12 +05:45
citron.html.markdown [Citron/en] Add basic explanations 2018-07-14 19:17:46 +04:30
clojure-macros.html.markdown [clojure-macros] Fixed links (#3351) 2018-10-31 06:44:17 +05:30
clojure.html.markdown Fix the as-> macro exemple (#4054) 2021-01-15 11:31:24 +01:00
cmake.html.markdown Some grammar, vocabulary improvements 2020-02-27 15:32:44 -05:00
cobol.html.markdown Fix typo in data item definition (#4076) 2021-01-15 11:31:38 +01:00
coffeescript.html.markdown Move the description to the beginning with the other text 2016-12-14 15:53:36 -08:00
coldfusion.html.markdown Set syntax highlighting for coldfusion 2016-12-31 15:36:08 -08:00
common-lisp.html.markdown Update common-lisp.html.markdown 2019-10-11 22:07:05 +02:00
compojure.html.markdown Use keywords in POST/PUT examples 2015-05-30 11:43:37 -06:00
CONTRIBUTING.markdown [CONTRIBUTING.markdown] Change "buid" to "build" 2020-01-31 14:20:14 -06:00
coq.html.markdown Merge pull request #4140 from dbenn/patch-1 2021-03-21 15:23:05 +01:00
crystal.html.markdown changed http link to https 2020-04-12 20:21:54 +02:00
csharp.html.markdown Merge pull request #3794 from AjitZero/patch-1 2020-01-28 19:02:50 +01:00
css.html.markdown Merge pull request #3697 from apooravc/add-css-resource 2020-01-11 14:25:43 +05:30
cypher.html.markdown Escaping underscores (unwanted italic) 2019-05-15 15:49:36 +02:00
d.html.markdown Added missing import std.stdio... 2020-01-22 12:16:26 +00:00
dart.html.markdown Merge pull request #3879 from Hiyorimi/patch-2 2020-07-08 14:12:31 +02:00
dhall.html.markdown [dhall/de]: add German translation (#3600) 2019-08-19 18:27:50 +05:30
directx9.html.markdown [directx9/en, opengl/en] Add basic DirectX 9 and rename OpenGL (#3599) 2019-08-19 18:24:31 +05:30
docker.html.markdown Fix another typo 2021-02-25 13:10:55 -05:00
dynamic-programming.html.markdown Fix whitespace to be consistent 2020-02-29 14:01:02 -08:00
edn.html.markdown Improve the "Tagged Elements" section of EDN doc 2017-10-21 20:33:14 -04:00
elisp.html.markdown t evaluates to t, so it doesn't need to be quoted 2019-03-18 21:17:45 +00:00
elixir.html.markdown [elixir/en] Update description of an Atom. (#4216) 2021-08-22 17:21:22 +02:00
elm.html.markdown [elm] Update code to access tuples 2017-12-23 11:57:45 +01:00
emacs.html.markdown Update emacs.html.markdown 2019-08-03 17:06:50 +05:30
erlang.html.markdown [erlang] Update guard sequences URL to use named id (#2613) 2016-12-29 01:41:35 +01:00
factor.html.markdown Factor highlight is here 2018-10-23 20:36:28 -07:00
file.erb Added filename parameter 2013-06-29 20:19:14 -07:00
forth.html.markdown Fix tuck definition 2017-10-16 14:32:51 +08:00
fortran95.html.markdown [fortran/en] Add new resource (#4213) 2021-08-22 17:24:09 +02:00
fsharp.html.markdown [F#/en] Fsharp dugnad 15 07 2020 (#3973) 2020-08-08 22:52:13 -07:00
Gemfile Add rubygems.org as gem source so Travis CI can use charlock_holmes 2016-11-09 21:02:04 -08:00
Gemfile.lock adds Gemfile.lock (#2664) 2017-03-21 18:19:49 -07:00
git.html.markdown Update git.html.markdown 2020-07-02 13:28:08 -04:00
go.html.markdown Fix typo in build tag description 2020-12-03 13:16:43 -07:00
groovy.html.markdown Fix typo in groovy.html.markdown 2020-05-23 15:17:29 -07:00
hack.html.markdown Fix a bunch of typos 2017-08-23 10:14:39 +02:00
haml.html.markdown [haml/en] Fix mistakes in English text 2017-09-28 09:00:33 +03:00
haskell.html.markdown [Haskell/en] Explain the !! operator 2020-10-15 12:34:01 -07:00
haxe.html.markdown whitespace 2019-09-29 23:29:13 -04:00
hdl.html.markdown [hdl/en] Add Hardware Description Language Documentation 2019-10-22 21:39:03 -05:00
hq9+.html.markdown 2431 2017-05-25 14:29:39 +02:00
hre.csv Add hre.csv to this repo directly 2018-10-15 23:22:14 -04:00
html.html.markdown [html/gr] Add greek translation for the HTML language (#3588) 2019-08-03 23:55:27 +05:30
hy.html.markdown Fix a bunch of typos 2017-08-23 10:14:39 +02:00
inform7.html.markdown Add a try at an Inform 7 tutorial. 2016-01-22 00:54:44 +00:00
janet.html.markdown Update janet.html.markdown 2020-08-18 06:17:31 -04:00
java.html.markdown [java/en] Added more info about Collections initialization (#4200) 2021-08-22 20:21:01 +02:00
javascript.html.markdown Purge my deadname 2020-02-13 10:38:29 +10:30
jquery.html.markdown Added note 2020-10-16 09:24:10 +05:30
json.html.markdown [json/en] use https 2020-10-20 15:47:53 +08:00
jsonnet.html.markdown typo and grammar fix 2020-12-15 13:00:46 -08:00
julia.html.markdown Small update on julia.html.markdown, typos and comments 2021-01-28 17:46:32 +01:00
kdb+.html.markdown update broken link 2020-01-23 19:57:30 -05:00
kotlin.html.markdown Update kotlin.html.markdown 2021-02-04 18:25:10 +00:00
lambda-calculus.html.markdown Update lambda-calculus.html.markdown 2019-03-17 13:36:27 -04:00
latex.html.markdown input which are => inputs which are 2021-01-31 22:25:39 +01:00
lbstanza.html.markdown Added the LB Stanza Progamming Language 2020-08-08 22:39:52 -07:00
ldpl.html.markdown Update ldpl.html.markdown 2020-05-24 14:08:31 -07:00
less.html.markdown missing right parenthesis (#2596) 2016-12-13 02:29:12 +01:00
lfe.html.markdown Update lfe.html.markdown 2017-08-18 10:12:58 -07:00
linker.html.markdown [linker] Fix Russian language link 2019-12-02 13:28:29 -05:00
livescript.html.markdown removing whitespace all over 2015-10-07 23:11:24 -04:00
logtalk.html.markdown Improve section on compiling and loading source files 2019-02-03 17:23:31 +00:00
LOLCODE.html.markdown Update LOLCODE.html.markdown 2017-07-04 13:24:03 -07:00
lua.html.markdown Fixed dead link for Lua for programmers 2021-01-31 10:04:36 -05:00
m.html.markdown [M (MUMPS)/en] One-liner 2019-02-13 11:06:16 +01:00
make.html.markdown Move "make" articles to the "tool" category 2019-03-08 17:21:53 +01:00
markdown.html.markdown Fix build error in 'build/docs/markdown/index.html' 2018-08-15 17:41:56 +05:30
matlab.html.markdown Rename OS X to macOS (#4166) 2021-05-25 13:42:50 +02:00
mercurial.html.markdown [mercurial/en] Fix mercurial workflow link 2019-08-13 17:22:11 +08:00
mercury.html.markdown use Prolog syntax highlighting for Mercury code 2019-08-16 14:10:39 -05:00
messagepack.html.markdown Add messagepack as a tool 2016-10-21 15:36:15 -07:00
mips.html.markdown minor fix for uncommented comment line 2020-05-08 09:29:38 +02:00
mongodb.html.markdown [MongoDB/en] Add Learn MongoDB in Y Minutes (#4214) 2021-08-22 17:51:43 +02:00
montilang.html.markdown Update montilang.html.markdown 2018-09-08 23:46:28 +10:00
moonscript.html.markdown Fix reference to an undefined variable 2020-05-24 14:28:10 -07:00
neat.html.markdown removing whitespace all over 2015-10-07 23:11:24 -04:00
nim.html.markdown Nim: Fix syntax error 2020-07-19 23:16:14 -07:00
nix.html.markdown Fix typo in nix documentation 2020-05-29 20:55:46 -04:00
objective-c.html.markdown Rename OS X to macOS (#4166) 2021-05-25 13:42:50 +02:00
ocaml.html.markdown [ocaml/en] Fix typo 2019-01-09 17:10:06 -08:00
opencv.html.markdown Fixed the links to be clickable 2020-07-23 00:21:41 -07:00
opengl.html.markdown [opengl/en] Add Basic OpenGL 3.3+ (#3577) 2019-08-03 18:19:45 +05:30
p5.html.markdown Update p5.html.markdown 2020-06-01 14:56:26 -03:00
paren.html.markdown Updating header with contribution name 2015-10-20 11:40:45 -03:00
pascal.html.markdown Fixed a spelling mistake 2020-02-25 19:13:42 +05:30
pcre.html.markdown Tweak markdown to properly render html 2019-09-20 14:12:41 +10:00
perl.html.markdown Perl6 to Raku and many more 2020-06-10 16:33:01 +05:45
pets.csv Create pets.csv 2013-06-29 03:38:34 -04:00
php-composer.html.markdown [php-composer/en] Add new tool document for Composer, PHP's dependency manager. 2015-10-20 12:46:58 +13:00
php.html.markdown Merge pull request #3940 from pendashteh/patch-1 2020-07-07 15:31:14 +02:00
pogo.html.markdown Fixed typo at the end 2014-12-22 13:26:30 +01:00
powershell.html.markdown Adjusting formatting 2020-10-06 18:02:35 -07:00
processing.html.markdown Changed color definition 2020-03-01 22:57:55 +01:00
prolog.html.markdown typo fix in prolog.html.markdown 2019-06-19 14:01:48 -04:00
protocol-buffer-3.html.markdown [proto/en] Adding Protocol Buffer 3 2019-07-29 20:26:45 +05:30
pug.html.markdown Pug language 2019-06-13 13:10:53 -04:00
purescript.html.markdown Update various examples 2021-03-22 17:49:10 +01:00
pyqt.html.markdown try to fix (again) #2496 2016-10-23 14:24:50 +02:00
python.html.markdown Fix tiny typos 2021-01-15 17:44:19 -05:00
pythonlegacy.html.markdown Change 'filename:' for Python 2 (legacy) 2020-02-12 07:04:42 +01:00
pythonstatcomp.html.markdown Add import to resolve changes in new versions of python 2018-10-15 23:22:34 -04:00
qsharp.html.markdown [qsharp/en] Remove mention of multi-line comments 2020-08-06 17:45:30 -07:00
qt.html.markdown Add language code suffix(#2832) 2017-08-25 14:03:17 +05:45
r.html.markdown Remove binary gender example from R (#4082) 2021-01-15 11:30:42 +01:00
racket.html.markdown Fix section numbering 2018-12-03 22:30:37 +01:00
Rakefile Update rakefile so that it will return an exit code of 1 if there is a failure (Travis CI needs this). Make ISO-8859* encoding detections notices not failures 2016-11-09 22:15:03 -08:00
raku-pod.html.markdown Perl6 to Raku and many more 2020-06-10 16:33:01 +05:45
raku.html.markdown [Raku/en] Fix runaway comment for syntax highlighter (#4215) 2021-08-21 23:46:05 +02:00
raylib.html.markdown Add raylib tutorial 2020-07-09 23:41:03 +02:00
README.markdown Fix missing parenthesis 2016-11-09 22:31:46 -08:00
reason.html.markdown fix typo 2019-11-15 22:53:36 -05:00
red.html.markdown Fix Stack Overflow link 2020-07-25 23:04:36 +05:30
rst.html.markdown Edited typos 2020-09-25 17:05:28 +01:00
ruby-ecosystem.html.markdown Update ruby-ecosystem.html.markdown 2018-08-02 14:43:03 +01:00
ruby.html.markdown [ruby/all] Replace tryruby.org with the proper link (#4217) 2021-08-21 23:08:42 +02:00
rust.html.markdown Change call 2020-02-12 21:25:39 +01:00
sass.html.markdown Update Sass Example to use proper syntax highlighting 2019-10-31 18:37:56 -05:00
scala.html.markdown Update Scala - clarify return keyword usage 2020-05-30 12:31:36 -04:00
self.html.markdown [self-en] separeated -> separated 2016-02-22 20:27:17 -07:00
set-theory.html.markdown [set-theory/fr] Added French translation for Set theory (#4168) 2021-07-11 16:28:54 +02:00
shutit.html.markdown Fix a bunch of typos 2017-08-23 10:14:39 +02:00
smallbasic.html.markdown [smallbasic/en] minor fact check fix (#2312) 2016-07-17 01:51:57 +02:00
smalltalk.html.markdown Correcting orthograph 2020-10-01 07:55:51 +02:00
solidity.html.markdown updated for v0.6 with fewer oracle details 2021-03-26 08:05:58 -04:00
sql.html.markdown Update URL 2020-09-22 09:13:57 -04:00
standard-ml.html.markdown Fix broken author homepage links, add Exercism.io link 2019-12-12 07:14:11 +01:00
stylus.html.markdown Fix empty lines 2019-01-10 17:07:51 +05:30
swift.html.markdown Rename OS X to macOS (#4166) 2021-05-25 13:42:50 +02:00
tcl.html.markdown fix typo 2020-12-11 02:14:00 -06:00
tcsh.html.markdown Move "tcsh" articles to the "tool" category 2019-03-08 17:22:26 +01:00
textile.html.markdown Update textile.html.markdown 2018-10-07 15:10:11 -07:00
tmux.html.markdown Fix keybinding 2019-08-08 22:16:37 +05:30
toml.html.markdown [toml/en] fix code not rendering (#4221) 2021-08-23 10:54:29 +02:00
typescript.html.markdown [typescript/en] incorrect syntax in inheritance example 2020-06-15 13:20:17 +05:30
vala.html.markdown Added profiles and D-Bus integration reading 2017-08-26 11:33:08 -04:00
vim.html.markdown Merge pull request #3954 from YatinAdityaT/patch-2 2020-08-18 12:29:09 +02:00
vimscript.html.markdown Fix minor issues 2020-02-02 17:56:16 +01:00
visualbasic.html.markdown Typo 2019-03-13 23:03:26 +03:00
vyper.html.markdown [vyper/en] Update vyper.html.markdown 2019-04-23 19:27:49 -04:00
wasm.html.markdown Remove wrong comment 2020-04-05 01:12:31 +03:00
whip.html.markdown Add comment to separate functions categories 2017-10-23 16:31:26 -02:00
wolfram.html.markdown Correct output 2019-07-02 10:13:37 +08:00
xml.html.markdown [xml/en] copy edit and fix code typo 2020-10-02 21:43:32 +00:00
yaml.html.markdown [yaml/en] Remove unused anchor 2020-10-20 16:56:44 +08:00
zfs.html.markdown fix unclosed code block, command prompts, spelling 2019-07-26 16:29:23 -04:00

README.markdown

Learn X in Y minutes

Build Status

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.