update readme

khanakbhargava · Oct 10, 2018 · 2905550 · 2905550
1 parent f0cb6b6
commit 2905550
Showing 1 changed file with 13 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1,2 +1,14 @@
 # workflow
-Common workflow scripts for running jobs at HPC centers
+
+Common information and workflow scripts for running jobs at HPC centers
+
+## Editing and building the Sphinx docs
+
+In `sphinx_docs/source/`, edit any of the `.rst` files.  Then build the webpages
+in `sphinx_docs/` as:
+```
+make html
+```
+This will copy the HTML into the main `docs/` directory that GitHub
+Pages uses.  `git commit` and `git push` and the updates will appear
+in https://amrex-astro.github.io/workflow/