From 78de7ed98abff93fe5fef94907bcfa4f76dcef07 Mon Sep 17 00:00:00 2001
From: Steve Manuel <nilslice@gmail.com>
Date: Sat, 27 May 2017 10:27:51 -0700
Subject: adding docs to repo

---
 docs/README.md | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)
 create mode 100644 docs/README.md

(limited to 'docs/README.md')

diff --git a/docs/README.md b/docs/README.md
new file mode 100644
index 0000000..990cd92
--- /dev/null
+++ b/docs/README.md
@@ -0,0 +1,26 @@
+# Ponzu CMS + Server Framerwork Docs
+
+## Contributing
+
+Documentation contributions are welcome and appreciated. If you find something 
+lacking in documentation or have submitted a PR that is being merged into master, 
+please help everyone out and write some docs! 
+
+**Note:** Docker is required to follow these instructions, but you can also use
+MkDocs natively, [see details here](http://www.mkdocs.org/#installation). Ponzu
+docs use the "Material" [theme](http://squidfunk.github.io/mkdocs-material/).
+
+
+Here is how to run a local docs server and build them for release:
+
+1. Clone this repository
+```bash
+$ git clone https://github.com/ponzu-cms/docs.git
+``` 
+2. Start the development server which will watch and auto-build the docs
+```bash
+$ docker run --rm -it -p 8000:8000 -v `pwd`:/docs squidfunk/mkdocs-material
+``` 
+3. Submit a PR with your changes. If you run the build step, please do not add it to the PR.
+
+**Thank you!**
-- 
cgit v1.2.3