|
|
@@ -17,10 +17,20 @@
|
|
|
# along with BeeWatch. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
|
|
"""
|
|
|
-How to install BeeWatch
|
|
|
-=======================
|
|
|
+Installation Guide for BeeWatch
|
|
|
+===============================
|
|
|
+.. Warning:
|
|
|
+ This program only supports GNU/Linux distros. It may work under another platform but I doubt that.
|
|
|
+
|
|
|
+You can install the module, build the documentation or do both (advised ;P). If you install the module after you have built the documentation, the documentation is copied to the folder of the installed module.
|
|
|
|
|
|
+Install BeeWatch
|
|
|
+================
|
|
|
+To install BeeWatch run `./setup.py install` in BeeWatch-X.X. For more options run `./setup.py help` or see `Distributing on python.org <https://docs.python.org/3/distutils/index.html>`_
|
|
|
|
|
|
+Build the documentation
|
|
|
+=======================
|
|
|
+This project uses Sphinx for documentation generation. Sphinx can create the documentation in a variety of formats, eg html, pdf, epub an more. Run ``make help`` to get a list of supported file formats. Let's say you chose html, so you run ``make html``. This create the documentation in `docs/html`. The entry point is `docs/html/index.html`.
|
|
|
|
|
|
"""
|
|
|
|
|
|
@@ -64,11 +74,6 @@ setup(**setup_kwargs)
|
|
|
|
|
|
|
|
|
|
|
|
-
|
|
|
-
|
|
|
-
|
|
|
-
|
|
|
-
|
|
|
|
|
|
|
|
|
|
