Update documentation pages

README.md

@@ -2,11 +2,18 @@
 [![Test and build](https://github.com/mxcube/mxcubecore/actions/workflows/tests.yml/badge.svg)](https://github.com/mxcube/mxcubecore/actions/workflows/tests.yml)
 ![PyPI](https://img.shields.io/pypi/v/mxcubecore)
 
+
 # Backend of MXCuBE
-mxcubecore is the back-end level of [MXCuBE Qt](https://github.com/mxcube/mxcube/) and [MXCuBE Web](https://github.com/mxcube/mxcube3/)  allowing to access the beamline control system and instrumentation. It acts as a container of single python objects (called hardware objects).
 
-Please read the [contributing guidlines](https://github.com/mxcube/mxcubecore/blob/master/CONTRIBUTING.md/) before submiting your code to the repository.
+mxcubecore is the back-end library for
+[MXCuBE Qt](https://github.com/mxcube/mxcubeqt/)
+and [MXCuBE Web](https://github.com/mxcube/mxcubeweb/).
+It allows access to the beamline control system and instrumentation.
+It acts as a container of single Python objects (called "hardware objects").
 
+Please read the
+[contributing guidelines](https://mxcubecore.readthedocs.io/en/stable/dev/contributing.html)
+before submitting your code to the repository.
 
 MXCuBE is free software: you can redistribute it and/or modify
 it under the terms of the GNU Lesser General Public License as published by
@@ -21,12 +28,23 @@ GNU Lesser General Public License for more details.
 You should have received a copy of the GNU Lesser General Public License
 along with MXCuBE. If not, see <https://www.gnu.org/licenses/>.
 
+
 # Installation
 
-Installation of the mxubecore module is commonly done as a depdency of either [MXCuBE Web](https://github.com/mxcube/mxcube3/) or [MXCuBE Qt](https://github.com/mxcube/mxcube/).
+Installation of the mxubecore module is commonly done as a dependency of either
+[MXCuBE Web](https://github.com/mxcube/mxcubeweb/)
+or [MXCuBE Qt](https://github.com/mxcube/mxcubeqt/).
 
-Standalone installation of the moudle can be done via poetry `poetry install` or for development purpouses (creating a symlink to the current folder) by using pip: `pip install -e .`. Don't forget the trailing "." (period).
+Standalone installation of the module for development purposes can be done
+via Poetry with `poetry install`
+or via pip with `python -m pip install --editable .` (don't forget the trailing dot `.`).
 
-mxcubecore depends on python-ldap that in turn depends on the openldap system library. It can be installed through conda by installing the openldap depdency: `conda install openldap` or on systems using apt-get: `sudo apt-get install -y libldap2-dev libsasl2-dev slapd ldap-utils tox lcov valgrind`. See [python-ldap](https://www.python-ldap.org/en/python-ldap-3.4.3/installing.html#debian) for more information.
+mxcubecore depends on python-ldap that in turn depends on the openldap system library.
+It can be installed through conda by installing the openldap dependency: `conda install openldap`
+or on systems using the apt package manager (Debian and derivatives, including Ubuntu):
+`sudo apt-get install -y libldap2-dev libsasl2-dev`.
+See [python-ldap](https://www.python-ldap.org/en/python-ldap-3.4.3/installing.html#debian)
+for more information.
 
-See [Developer documentation](https://mxcubecore.readthedocs.io/) for more information on working with mxcubecore.
+See [Developer documentation](https://mxcubecore.readthedocs.io/)
+for more information on working with mxcubecore.

docs/source/dev/index.rst

@@ -9,6 +9,7 @@ Developer documentation
 .. toctree::
     :caption: Contents:
     :glob:
+    :maxdepth: 2
     :titlesonly:
 
     *