Skip to content

Commit 8dbfba1

Browse files
Oberon00Oberon00
committed
Initial commit.
0 parents  commit 8dbfba1

19 files changed

+2216
-0
lines changed

Diff for: ‎.gitignore

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
*.exe
2+
*.obj
3+
_build/*

Diff for: ‎Makefile

+179
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,179 @@
1+
# Makefile for Sphinx documentation
2+
#
3+
4+
# You can set these variables from the command line.
5+
SPHINXOPTS =
6+
SPHINXBUILD = sphinx-build
7+
PAPER =
8+
BUILDDIR = _build
9+
10+
.DEFAULT_GOAL := html # Manually inserted
11+
12+
# User-friendly check for sphinx-build
13+
ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
14+
$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
15+
endif
16+
17+
# Internal variables.
18+
PAPEROPT_a4 = -D latex_paper_size=a4
19+
PAPEROPT_letter = -D latex_paper_size=letter
20+
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
21+
# the i18n builder cannot share the environment and doctrees with the others
22+
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
23+
24+
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
25+
26+
help:
27+
@echo "Please use \`make <target>' where <target> is one of"
28+
@echo " html to make standalone HTML files"
29+
@echo " dirhtml to make HTML files named index.html in directories"
30+
@echo " singlehtml to make a single large HTML file"
31+
@echo " pickle to make pickle files"
32+
@echo " json to make JSON files"
33+
@echo " htmlhelp to make HTML files and a HTML help project"
34+
@echo " qthelp to make HTML files and a qthelp project"
35+
@echo " devhelp to make HTML files and a Devhelp project"
36+
@echo " epub to make an epub"
37+
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
38+
@echo " latexpdf to make LaTeX files and run them through pdflatex"
39+
@echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
40+
@echo " text to make text files"
41+
@echo " man to make manual pages"
42+
@echo " texinfo to make Texinfo files"
43+
@echo " info to make Texinfo files and run them through makeinfo"
44+
@echo " gettext to make PO message catalogs"
45+
@echo " changes to make an overview of all changed/added/deprecated items"
46+
@echo " xml to make Docutils-native XML files"
47+
@echo " pseudoxml to make pseudoxml-XML files for display purposes"
48+
@echo " linkcheck to check all external links for integrity"
49+
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
50+
51+
clean:
52+
rm -rf $(BUILDDIR)/*
53+
54+
html:
55+
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
56+
@echo
57+
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
58+
59+
dirhtml:
60+
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
61+
@echo
62+
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
63+
64+
singlehtml:
65+
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
66+
@echo
67+
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
68+
69+
pickle:
70+
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
71+
@echo
72+
@echo "Build finished; now you can process the pickle files."
73+
74+
json:
75+
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
76+
@echo
77+
@echo "Build finished; now you can process the JSON files."
78+
79+
htmlhelp:
80+
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
81+
@echo
82+
@echo "Build finished; now you can run HTML Help Workshop with the" \
83+
".hhp project file in $(BUILDDIR)/htmlhelp."
84+
85+
qthelp:
86+
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
87+
@echo
88+
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
89+
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
90+
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/OnC.qhcp"
91+
@echo "To view the help file:"
92+
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/OnC.qhc"
93+
94+
devhelp:
95+
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
96+
@echo
97+
@echo "Build finished."
98+
@echo "To view the help file:"
99+
@echo "# mkdir -p $$HOME/.local/share/devhelp/OnC"
100+
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/OnC"
101+
@echo "# devhelp"
102+
103+
epub:
104+
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
105+
@echo
106+
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
107+
108+
latex:
109+
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
110+
@echo
111+
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
112+
@echo "Run \`make' in that directory to run these through (pdf)latex" \
113+
"(use \`make latexpdf' here to do that automatically)."
114+
115+
latexpdf:
116+
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
117+
@echo "Running LaTeX files through pdflatex..."
118+
$(MAKE) -C $(BUILDDIR)/latex all-pdf
119+
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
120+
121+
latexpdfja:
122+
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
123+
@echo "Running LaTeX files through platex and dvipdfmx..."
124+
$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
125+
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
126+
127+
text:
128+
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
129+
@echo
130+
@echo "Build finished. The text files are in $(BUILDDIR)/text."
131+
132+
man:
133+
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
134+
@echo
135+
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
136+
137+
texinfo:
138+
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
139+
@echo
140+
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
141+
@echo "Run \`make' in that directory to run these through makeinfo" \
142+
"(use \`make info' here to do that automatically)."
143+
144+
info:
145+
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
146+
@echo "Running Texinfo files through makeinfo..."
147+
make -C $(BUILDDIR)/texinfo info
148+
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
149+
150+
gettext:
151+
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
152+
@echo
153+
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
154+
155+
changes:
156+
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
157+
@echo
158+
@echo "The overview file is in $(BUILDDIR)/changes."
159+
160+
linkcheck:
161+
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
162+
@echo
163+
@echo "Link check complete; look for any errors in the above output " \
164+
"or in $(BUILDDIR)/linkcheck/output.txt."
165+
166+
doctest:
167+
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
168+
@echo "Testing of doctests in the sources finished, look at the " \
169+
"results in $(BUILDDIR)/doctest/output.txt."
170+
171+
xml:
172+
$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
173+
@echo
174+
@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
175+
176+
pseudoxml:
177+
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
178+
@echo
179+
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."

Diff for: ‎README.markdown

+109
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
1+
Title: On the C++ Programming Language: Readme
2+
Author: Christian Neumüller
3+
4+
# About this project
5+
6+
7+
This tutorial aims to teach C++ as a first programming language.
8+
Read the [introduction][] for more information.
9+
10+
This tutorial is written using [Sphinx][] and ReStructuredText.
11+
12+
[introduction]: intro.rst
13+
[Sphinx]: http://sphinx-doc.org/
14+
15+
# On the C++ Programming Language: Planned Outline
16+
17+
## Introduction
18+
* Meta
19+
+ About this tutorial
20+
- Audience
21+
- Goals
22+
+ Why C++
23+
+ The ISO Standard
24+
+ A tiny bit of history
25+
* Hello World
26+
+ Compiler basics
27+
- Info
28+
- How To: Installing MSVC/g++
29+
+ The Hello World program
30+
+ Using the command line compiler
31+
* Resources [As in: books, links, ect.]
32+
33+
## The Basics: Procedural programming
34+
* Types, Expressions, Variables [hard!]
35+
* If/else
36+
* Loops (while, do…while, for)
37+
* Functions [potentially hard!]
38+
* Structures and typedefs
39+
* Constants and enums
40+
* Pass by reference
41+
* (Raw) Pointers
42+
* The heap and `unique_ptr`
43+
* `std::vector`
44+
* `std::string`
45+
46+
## The C/C++ “Module-System”
47+
* Translation Units, Headers, Linkage and the Linker
48+
* Namespaces
49+
* Example: Linked lists, stacks, queues
50+
* A cross-platform build-system: CMake
51+
* Using a library: SDL [good running example]
52+
+ Note to reader: You can't start here!
53+
54+
## Object Orientation
55+
* OO Principles
56+
* Struct/incomplete-type based OO
57+
* Classes and access control (“visibility”)
58+
* Value semantics: The big three
59+
+ RAII [SDL has many potential usages]
60+
* Inheritance and virtual functions
61+
* Interface idiom and a word about multiple inheritance
62+
* Linked lists, object oriented edition
63+
+ Iterators
64+
65+
* Interlude: Error handling and exceptions
66+
+ Return values
67+
+ Exceptions
68+
+ signals?
69+
70+
71+
## Introduction to Generic programming
72+
* Template basics
73+
* Function overloading
74+
* Linked lists, generic edition & `std::list`
75+
76+
## Solving old myths
77+
* Operator overloading: Demystifying `std::cout`
78+
* While we are at it: More on IO
79+
* Low Level Heap Management
80+
+ `new` and `delete`
81+
+ RAII: Implementing `ScopedPointer`
82+
* Move-Semantics and `std::unique_ptr`
83+
* Arrays and `std::vector`
84+
+ … and `std::array`
85+
86+
## Functional Programming
87+
* Function Pointers, Functors, Lambdas, `std::function`
88+
* Higher order functions [Ex.: STL algorithms]
89+
* Functional programming and OO
90+
91+
## Containers & algorithms (“STL”)
92+
* Concepts
93+
* Containers
94+
* Associative containers
95+
* Algorithms
96+
97+
98+
# Missing/further interesting topics
99+
* Test driven development
100+
* Template Meta Programming (TMP)
101+
+ Advanced template features
102+
+ Faculty example
103+
+ Tag dispatching
104+
* Important libraries
105+
+ boost
106+
+ Qt?
107+
* Network programming
108+
* Multithreading
109+
* Scripting: Lua

0 commit comments

Comments
 (0)