Merge pull request #52 from LovetheFrogs/36-fix-pypi-documentation

Added PyPI own README and updated setup.py

PyPI_docs.md

@@ -0,0 +1,51 @@
+# PyCircTools
+
+PyCircTools is a python package which contains tools to build circuits using python 3. It is a work in progress, and will be updated frequently to add more
+modules.
+
+
+<p><a href="#installing-ctools"> 1. Installing PyCircTools and importing it </a></p>
+<p><a href="#logic-gates"> 2. Logic Gates Module </a></p>
+<p><a href="#multiplexers"> 3. Multiplexers Module </a></p>
+<p><a href="#latches"> 4. Latches Module </a></p>
+<p><a href="#exceptions">5. Exceptions </a></p>
+<p><a href="#about">6. About </a></p>
+
+<a name="installing-ctools"></a>
+## Installing PyCircTools and importing it.
+
+To install PyCircTools, use pip by calling the following command:
+
+```
+pip install PyCircTools
+```
+Importing it is as easy as it gets, just insert the line 
+```
+from PyCircTools.*subpackage* import *modules*
+``` 
+at the start of your code, and substitute subpackage with the package you want, and modules with the modules you want to import to your project.
+
+<a name="logic-gates"></a>
+## Logic Gates Module
+
+To read the documentation for this module, [click this link](https://github.com/LovetheFrogs/PyCircTools/tree/main/PyCircTools/LogicGates).
+
+<a name="multiplexers"></a>
+## Multiplexers Module
+
+To read the documentation for this module, [click this link](https://github.com/LovetheFrogs/PyCircTools/tree/main/PyCircTools/Multiplexers).
+
+<a name="latches"></a>
+## Latches Module
+
+To read the documentation for this module, [click this link](https://github.com/LovetheFrogs/PyCircTools/tree/main/PyCircTools/Latches).
+
+<a name="exceptions"></a>
+## Exceptions
+
+To read the documentation for this module, [click this link](https://github.com/LovetheFrogs/PyCircTools/tree/main/PyCircTools/Exceptions).
+
+<a name="about"></a>
+## About
+
+PyCircTools is software developed by LovetheFrogs and licensed under GPL-3.0 license.

setup.py

@@ -3,11 +3,11 @@
 
 
 this_directory = Path(__file__).parent
-desc = (this_directory / "README.md").read_text()
+desc = (this_directory / "PyPI_docs.md").read_text()
 setup(
     name='PyCircTools',
-    packages=find_packages(include=['Exceptions', 'LogicGates', 'Multiplexers']),
-    version='0.1.0',
+    packages=find_packages(include=['Exceptions', 'LogicGates', 'Multiplexers', 'Latches']),
+    version='0.2.1',
     description='PyCircTools, a python circuit library.',
     author='LovetheFrogs',
     license='GPL-3.0',