From c9bd72c117bb94aa3b9b9569f7b86c3cf066d94c Mon Sep 17 00:00:00 2001
From: Mostapha Sadeghipour Roudsari <sadeghipour@gmail.com>
Date: Fri, 15 Mar 2019 16:20:55 -0400
Subject: [PATCH] Added instructions for usage

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

diff --git a/docs/README.md b/docs/README.md
new file mode 100644
index 00000000..31c0ca5e
--- /dev/null
+++ b/docs/README.md
@@ -0,0 +1,14 @@
+
+## Usage
+For generating the documents localy use commands below from the root folder. 
+
+```shell
+# install dependencies
+pip install Sphinx sphinxcontrib-fulltoc sphinx_bootstrap_theme
+
+# generate rst files for ladybug modules except for euclid
+sphinx-apidoc -f -e -d 4 -o ./docs ./ladybug ./ladybug/euclid.py
+
+# build the documentation under _build/docs folder
+sphinx-build -b html ./docs ./docs/_build/docs
+```