Skip to content

Commit

Permalink
Update readme, fix build instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
econchick committed Jan 19, 2015
1 parent 53070ca commit 6fd95d9
Show file tree
Hide file tree
Showing 3 changed files with 32 additions and 13 deletions.
42 changes: 31 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Genearl directory layout:
│   ├── README.md
│   ├── requirements.txt
│   ├── lib/
│ ├── tests/ # only for more advanced tutorials
│ ├── tests/ # only for more advanced tutorials

## CONTRIBUTING

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

## Documentation Build Instructions

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

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:

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

Once the compiler is set up:
To build the site:

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

To serve the site locally:

```bash
(newcoder-website) $ mynt serve _site
```

And navigate to `localhost:5000`.

I’ve included a simple script that combines the two above commands:

```bash
(newcoder-website) $ ./_local.sh
```

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:

```bash
(newcoder-website) $ chmod +x _local.sh
(newcoder-website) $ ./_local.sh
```
1 change: 0 additions & 1 deletion website/_deploy.sh

This file was deleted.

2 changes: 1 addition & 1 deletion website/requirements.txt
Original file line number Diff line number Diff line change
@@ -1 +1 @@
mynt<=0.2.99
mynt==0.3.1

0 comments on commit 6fd95d9

Please sign in to comment.