Merge pull request #8 from neutrons/design_docs

Design Documentation and Code Improvements
neutrons · Dec 11, 2024 · ee8dce0 · ee8dce0
2 parents 93f4171 + c0668b7
commit ee8dce0
Show file tree

Hide file tree

Showing 10 changed files with 603 additions and 72 deletions.
diff --git a/README.md b/README.md
@@ -23,5 +23,22 @@ Start the tool
 `hyspecppt`
 
 
+## Documentation Build locally
+
+Enter the documentation directory
+
+`cd docs\`
+
+Clean current build files, if they exist
+
+`make clean`
+
+Build the html files
+
+`make html`
+
+Documentation [hyspecppt.readthedocs.io](https://hyspecppt.readthedocs.io/)
+
+
 [![CI](https://github.com/neutrons/hyspecppt/actions/workflows/unittest.yml/badge.svg?branch=next)](https://github.com/neutrons/hyspecppt/actions/workflows/unittest.yml)
 [![codecov](https://codecov.io/gh/neutrons/hyspecppt/graph/badge.svg?token=GAQE3SS0HJ)](https://codecov.io/gh/neutrons/hyspecppt)