Skip to content

Commit 6fd95d9

Browse files
committed
Update readme, fix build instructions
1 parent 53070ca commit 6fd95d9

File tree

3 files changed

+32
-13
lines changed

3 files changed

+32
-13
lines changed

README.md

Lines changed: 31 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Genearl directory layout:
1414
│   ├── README.md
1515
│   ├── requirements.txt
1616
│   ├── lib/
17-
│ ├── tests/ # only for more advanced tutorials
17+
│ ├── tests/ # only for more advanced tutorials
1818

1919
## CONTRIBUTING
2020

@@ -26,18 +26,38 @@ When writing documentation, please use [smart quotes](http://en.wikipedia.org/wi
2626

2727
## Documentation Build Instructions
2828

29-
Documentation is essentially the website itself. Simple install requirements, run the build command within `website` directory.
29+
Documentation is essentially the website itself. Simply install requirements, run the build command within `website` directory:
3030

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:
3231

33-
* Mac:
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.
35-
* Fedora: `sudo yum install gcc python-devel`
36-
* Ubuntu: `sudo apt-get install build-essential python-dev` – you may need to run `sudo apt-get update` first.
32+
```bash
33+
$ mkvirtualenv newcoder-website
34+
(newcoder-website) $ cd website
35+
(newcoder-website) $ pip install -r requirements.txt
36+
```
3737

38-
Once the compiler is set up:
38+
To build the site:
3939

40-
pip install -r website/requirements.txt
41-
mynt gen website build
42-
(cd build && python -m SimpleHTTPServer)
40+
```bash
41+
(newcoder-website) $ mynt gen -f _site
42+
```
4343

44+
To serve the site locally:
45+
46+
```bash
47+
(newcoder-website) $ mynt serve _site
48+
```
49+
50+
And navigate to `localhost:5000`.
51+
52+
I’ve included a simple script that combines the two above commands:
53+
54+
```bash
55+
(newcoder-website) $ ./_local.sh
56+
```
57+
58+
If you get a `permission denied` message, you may need to change the file mode in order to run the `_local.sh` with the `./` preceeding:
59+
60+
```bash
61+
(newcoder-website) $ chmod +x _local.sh
62+
(newcoder-website) $ ./_local.sh
63+
```

website/_deploy.sh

Lines changed: 0 additions & 1 deletion
This file was deleted.

website/requirements.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
mynt<=0.2.99
1+
mynt==0.3.1

0 commit comments

Comments
 (0)