From bb15a5a2221b98efe6224bc7755a14ceb9da75c7 Mon Sep 17 00:00:00 2001
From: Ethan Paul <e@enp.one>
Date: Tue, 27 Aug 2019 23:25:50 -0400
Subject: [PATCH] Update readme and add gitignore

---
 .gitignore |  1 +
 README.md  | 49 +++++++++++++++++++++++++++++++++++++++++++++++--
 2 files changed, 48 insertions(+), 2 deletions(-)
 create mode 100644 .gitignore

diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..45ddf0a
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1 @@
+site/
diff --git a/README.md b/README.md
index 5a15061..b8f2578 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,48 @@
-# docs
+# omni-docs
+
+ENP.One system and infrastructure documentation, using [MkDocs](https://www.mkdocs.org/)
+
+## Building
+
+1. Install [Pipenv](https://docs.pipenv.org/en/latest/)
+
+   ```shell
+   pip install pipenv --user
+   ```
+
+2. Synchronize environment
+
+   ```shell
+   pipenv sync
+   ```
+
+3. Build documentation
+
+   ```shell
+   pipenv run mkdocs build
+   ```
+
+Built docs are now located in `site/` and can be served as static HTML. See [MkDocs deployment](https://www.mkdocs.org/#deploying)
+
+## Editing/Developing
+
+1. Install [Pipenv](https://docs.pipenv.org/en/latest/)
+
+   ```shell
+   pip install pipenv --user
+   ```
+
+2. Synchronize environment, with development dependencies
+
+   ```shell
+   pipenv sync --dev
+   ```
+
+3. Run development server
+
+   ```shell
+   pipenv run mkdocs serve
+   ```
+
+4. Edit away!
 
-Network documentation
\ No newline at end of file