From 9a71464100537846b592614da8a24befdf1fe1bd Mon Sep 17 00:00:00 2001 From: Tanner Date: Thu, 23 Mar 2017 12:05:06 +0100 Subject: [PATCH 1/2] Create README.md --- README.md | 3 +++ 1 file changed, 3 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 00000000..fbbb75e2 --- /dev/null +++ b/README.md @@ -0,0 +1,3 @@ +# Documentation + +Read the docs at [docs.vapor.codes](http://docs.vapor.codes) From cb764475e881dd5405022fc6e8d41ece444f5f13 Mon Sep 17 00:00:00 2001 From: Tanner Date: Thu, 23 Mar 2017 12:57:23 +0100 Subject: [PATCH 2/2] Update CONTRIBUTING.md --- CONTRIBUTING.md | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 20663c07..09e3f508 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,4 +4,21 @@ Found a mistake or want to add something? Fork the documentation, fix it, and su We'll merge it as soon as we can. -Thanks! \ No newline at end of file +Thanks! + +## Developing + +### 1.0 + +Install `couscous` through Composer and run `couscous preview` + +### 2.0 + +Install MkDocs and MkDocs Material theme. + +```sh +pip install mkdocs +pip install mkdocs-material +``` + +Run with `mkdocs serve`