Merge pull request #34 from nextstrain/add-development-readme

document how to develop theme
nextstrain · Oct 13, 2022 · 679d1d6 · 679d1d6
2 parents eb4f16c + 75156ca
commit 679d1d6
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/README.rst b/README.rst
@@ -49,6 +49,16 @@ to point to the image file in your Sphinx project.
 This will automatically take precedence over the default Nextstrain logo
 provided by the theme.
 
+Development
+-----------
+
+.. code:: bash
+
+    python3 -m pip install -e .
+    make clean # not always needed, but better to be cautious
+    make html
+    open build/html/index.html
+
 Releasing
 ---------