diff --git a/README.md b/README.md index ee8ef059..29cbc32a 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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 +``` diff --git a/website/_deploy.sh b/website/_deploy.sh deleted file mode 100755 index 28d70b96..00000000 --- a/website/_deploy.sh +++ /dev/null @@ -1 +0,0 @@ -mynt gen -f _site && rsync -rupaz _site/ u52704@roguelynn.com:newcoder diff --git a/website/requirements.txt b/website/requirements.txt index cd7eb369..0e3d68b4 100644 --- a/website/requirements.txt +++ b/website/requirements.txt @@ -1 +1 @@ -mynt<=0.2.99 +mynt==0.3.1