Initial README file #1

README.md

@@ -1,2 +1,57 @@
-# pyspis
-Python library of the Satellite Power Input Simulator (SPIS)
+# PySPIS
+
+<a href="https://pypi.org/project/pyspis/">
+    <img src="https://img.shields.io/pypi/v/pyspis?style=for-the-badge">
+</a>
+<a href="https://pypi.org/project/pyspis/">
+    <img src="https://img.shields.io/pypi/pyversions/pyspis?style=for-the-badge">
+</a>
+<a href="https://github.com/mgm8/pyspis/blob/main/LICENSE">
+    <img src="https://img.shields.io/github/license/mgm8/pyspis?style=for-the-badge">
+</a>
+<a href="https://github.com/mgm8/pyspis/actions">
+    <img src="https://img.shields.io/github/actions/workflow/status/mgm8/pyspis/test.yml?style=for-the-badge">
+</a>
+
+## Overview
+
+Python library of the Satellite Power Input Simulator (SPIS).
+
+## Dependencies
+
+* None
+
+## Installing
+
+This library is available in the PyPI repository, and can be installed with the following command:
+
+* ```pip install pyspis```
+
+Or, directly from the source files:
+
+* ```python setup.py install```
+
+## Documentation
+
+The documentation page is available [here](https://mgm8.github.io/pyspis/). Instructions to build the documentation page are described below.
+
+Contributing instructions are also available [here](https://github.com/mgm8/pyspis/blob/main/CONTRIBUTING.md).
+
+### Dependencies
+
+* [Sphinx](https://pypi.org/project/Sphinx/) - v6.1.3
+* [sphinx-rtd-theme](https://pypi.org/project/sphinx-rtd-theme/) - v1.1.1
+
+### Building the Documentation
+
+The documentation pages can be built with Sphinx by running the following command inside the ``docs`` folder:
+
+* ```make html```
+
+## Usage Example
+
+> TODO
+
+## License
+
+This project is licensed under LGPLv3 license.