Skip to content

armgit / mocha

Public Imported from GitHub
0

☕️ Classic, reliable, trusted test framework for Node.js and the browser

resolves #1333: documentation for build of documentation

Christopher Hiller10914be0d4dd
diff --git a/README.md b/README.md
new file mode 100644
index 00000000..337ed1f8
--- /dev/null
+++ b/README.md
@@ -0,0 +1,72 @@
+# mocha: How to Build the Site
+
+So you wanna build the site?
+
+## Requirements
+
+There's two:
+
+1. [make](http://www.gnu.org/software/make/)
+2. [peg-markdown](https://github.com/jgm/peg-markdown)
+
+### Mac OS X
+
+1. Get [Homebrew](http://brew.sh). Install it. Great. Command at the time of writing was:
+
+ ```sh
+ ruby -e "$(curl -fsSL https://raw.github.com/Homebrew/homebrew/go/install)"
+ ```
+
+2. Assert `make` exists by executing:
+
+ ```sh
+ which make
+ ```
+
+3. If `which` did not return a path to the `make` executable, choose your own adventure:
+
+ - Download & install "Command Line Tools for Xcode" which is [buried somewhere in here](https://developer.apple.com/downloads/index.action#), and requires an Apple ID, or
+
+ - Install `make` via Homebrew:
+
+ ```sh
+ brew install make
+ ```
+
+ *Homebrew will not let you install `make` via the second method if it is already installed via the first method.*
+
+4. Install `peg-markdown` and symlink it to the `markdown` command:
+
+ ```sh
+ brew install peg-markdown && \
+ ln -s /usr/local/bin/peg-markdown /usr/local/bin/markdown
+ ```
+
+ If Homebrew complains, you might want to try this instead:
+
+ ```sh
+ brew link xz --overwrite && \
+ brew install peg-markdown && \
+ ln -s /usr/local/bin/peg-markdown /usr/local/bin/markdown
+ ```
+
+5. Celebrate with tequila! Or try to build first. Probably want to build first.
+
+### Linux
+
+*To be filled in by somebody using Linux*
+
+### Windows
+
+*To be filled in by somebody using Windows*
+
+## Building
+
+Execute:
+
+```
+make clean && make
+```
+
+You should now have an updated `index.html`. Open it in your browser and proceed to tweak it until it's correct, because the compiler seem a little wonky.
+