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` 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)