Updated README and added requirements.txt for documentation (#11)

* Updated README and added requirements.txt for documentation

* modify github action. add pip install -r

* Update requirements.txt

* update instruction to install doc builiding pkg in requirements.txt which is in docs folder instead of root folder

* modified github workflow to install doc pkg from docs/requirements.txt

.github/workflows/pytest.yml

@@ -28,6 +28,7 @@ jobs:
         python -m pip install build
         python -m pip install pytest
         pip install .
+        pip install -r docs/requirements.txt
     - name: Test with pytest
       run: |
         pytest -v test

README.md

@@ -26,6 +26,15 @@ Or, if you wish to edit the pySLM2 source code without re-installing each time
 ```
 pip install -e .
 ```
+To view pySLM2 documentation, some additional packages are required. In the pySLM2 directory, do
+```
+pip install -r docs/requirements.txt
+```
+This will install the necessary packages for building the documentation. Then  `cd` to the docs directory and in command line do 
+```
+make html
+```
+HTML files for the documentation will be generated and can be viewed in browser.
 
 Optional Dependencies for Hardware Controls
 -------------------------------------------

docs/requirements.txt

@@ -0,0 +1,6 @@
+matplotlib
+furo
+m2r2
+sphinx
+sphinx-math-dollar
+sphinx_pyproject