Add info on how to install and how to format docstrings

tillbiskup · Jun 20, 2019 · cf924b0 · cf924b0
1 parent 78f56cc
commit cf924b0
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 1 deletion.
diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-0.1.0.dev12
+0.1.0.dev13
diff --git a/docs/developers.rst b/docs/developers.rst
@@ -58,3 +58,19 @@ A general overview of the overall package structure::
 
 As you can see, currently three subpackages, namely "datasafe", "loi", and "eln", are supposed to be created. For details of the LabInform project as such, consult its `Homepage <https://www.labinform.de/>`_.
 
+
+Docstring format
+----------------
+
+The Docstring format used within the code of the LabInform package is "NumPy". For convenience, set your IDE accordingly.
+
+For PyCharm, the settings can be found in ``Preferences`` > ``Tools`` > ``Python Integrated Tools``. Here, you find a section "Docstrings" where you can select the Docstring format from a number of different formats.
+
+
+Unittests and test driven development
+-------------------------------------
+
+Developing the LabInform code should be done test-driven wherever possible. The tests reside in the ``tests`` directory in the respective subpackage directory (see above).
+
+Tests should be written using the Python :mod:`unittest` framework. Make sure that tests are independent of the respective local environment and clean up afterwards (using appropriate ``teardown`` methods).
+
diff --git a/docs/index.rst b/docs/index.rst
@@ -32,6 +32,16 @@ And to make it even more convenient for users and future-proof:
   LabInform is currently under active development and still considered in Alpha development state. Therefore, expect frequent changes in features and public APIs that may break your own code. Nevertheless, feedback as well as feature requests are highly welcome.
 
 
+Installation
+------------
+
+Install the package by running::
+
+  pip install labinform
+
+This will install the version from the `Python Package Index (PyPI) <https://pypi.org/>`_. To get the latest development version, clone the repository from `GitHub <https://github.com/tillbiskup/labinform>`_ and install it locally. In any case, it is highly recommended to use virtual environments to separate dependencies.
+
+
 
 Where to start
 --------------