You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
New Coder tutorials: 5 life jackets to throw the new coder
5
4
@@ -9,26 +8,29 @@ New Coder tutorials: 5 life jackets to throw the new coder
9
8
* Networking
10
9
* GUI
11
10
12
-
Directory layout:
11
+
Genearl directory layout:
13
12
14
13
├── <Project>/
15
14
│ ├── README.md
16
15
│ ├── requirements.txt
17
16
│ ├── lib/
18
-
│ │ ├── full_source/
19
-
│ │ ├── tutorial_source/
20
-
│ ├─── tests/
21
-
│ │ ├── full_tests/
22
-
│ │ ├── tutorial_tests/
17
+
│ ├─── tests/ # only for more advanced tutorials
23
18
24
-
Documentation Build Instructions
25
-
==================
19
+
## CONTRIBUTING
26
20
27
-
Simple install requirements, run the build command within `website` directory.
21
+
22
+
*PLEASE* – When editing tutorial or full source code, please edit the documentation to go along with it within the `website` folder (and vice-versa).
23
+
24
+
When writing documentation, please use [smart quotes](http://en.wikipedia.org/wiki/Quotation_mark_glyphs). :)
25
+
26
+
27
+
## Documentation Build Instructions
28
+
29
+
Documentation is essentially the website itself. Simple install requirements, run the build command within `website` directory.
28
30
29
31
You will need a C compiler: [GCC](http://gcc.gnu.org/) or [clang](http://clang.llvm.org/). To test if you have either GCC or clang, type `gcc` or `clang` into your terminal. If you get an error that says “command not found” then follow the install instructions for your OS:
30
32
31
-
* Mac:
33
+
* Mac:
32
34
* You will need [XCode](http://developer.apple.com/xcode). Once you have XCode on your machine, you will need to navigate to **Preferences** –> **Downloads** –> and select **Command Line Tools** to download & install.
33
35
* Fedora: `sudo yum install gcc python-devel`
34
36
* Ubuntu: `sudo apt-get install build-essential python-dev` – you may need to run `sudo apt-get update` first.
@@ -39,20 +41,3 @@ Once the compiler is set up:
39
41
mynt gen website build
40
42
(cd build && python -m SimpleHTTPServer)
41
43
42
-
43
-
CONTRIBUTING
44
-
============
45
-
46
-
PLEASE – When editing tutorial or full source code, please edit the documentation to go along with it within the `website` folder (and vice-versa).
47
-
48
-
When writing documentation, please use [smart quotes](http://en.wikipedia.org/wiki/Quotation_mark_glyphs).
49
-
50
-
51
-
TODOs
52
-
=====
53
-
54
-
1. Network/IRC bot tutorial language
55
-
2. Sudoku/GUI tutorial language
56
-
5. Add better tags for subjects that are covered in tutorial parts (e.g. Generators, Iterators, classes, etc).
57
-
6. Learn anchoring for Mynt/Markdown
58
-
7. Remove the opening of the dataviz files in the tutorial to not give away the answers!
0 commit comments