README.md

+# Core-tools
+Core-tools is a light-weight dataset that supports common spin-qubit measurement practices. 
+It features a local data storage solution, as well as tools for remote storage.
 
-# core tools
+## Documentation
+Core-tools documentation can be found in a couple of different locations.
 
-This GitHub repository is not maintained anymore.
+### Project
+Project documentation can be found as a set of markdown files in the ```docs/source``` directory, starting with ```docs/source/index.rst```.
+
+For convenience, it is possible to compile these documents into a set of HTML files that you can read in your browser.
+
+On Windows:
+```bat
+.\.venv\Scripts\activate
+pip install sphinx
+cd docs/
+make.bat html
+```
+
+On Linux:
+```bash
+source .venv/bin/activate
+pip install sphinx 
+cd docs/
+make html
+```
+
+You can now access the documentation by opening ```docs/build/html/index.html``` in your web-browser of choice.
+
+### Configuration
+For users associated with QuTech or the TU Delft, there are wiki-pages documenting how to set up a measurement environment using core-tools.
+
+These pages are located on the [QDLabs GitLab wiki](https://gitlab.tudelft.nl/qutech-qdlabs/measurement-systems/documentation/-/wikis/home).
 
-It has moved to https://gitlab.tudelft.nl/qutech-qdlabs/core_tools

docs/source/introduction_db.md

@@ -18,13 +18,14 @@ Steps:
 1. Download [PostgreSQL](https://www.postgresql.org/download/)
 2. Go through the installer and install the database.
 3. Launch the psql program and make a database user and a database (press enter until the shell asks for the password configured in the installation). Type the following commands:
-    * CREATE USER myusername WITH PASSWORD 'mypasswd';
-    * CREATE DATABASE 'mydbname';
-    * GRANT ALL PRIVILEGES ON DATABASE 'mydbname' TO 'myusername';
-    * \connect 'mydbname'
-    * GRANT CREATE ON SCHEMA public TO 'myusername';
-
-   Note: The last line is required since release 15 of Postgresql.
+```SQL
+CREATE USER myusername WITH PASSWORD 'mypasswd';
+CREATE DATABASE 'mydbname';
+GRANT ALL PRIVILEGES ON DATABASE 'mydbname' TO 'myusername';
+\connect 'mydbname'
+GRANT CREATE ON SCHEMA public TO 'myusername';
+```
+*Note: The last line is required since release 15 of Postgresql.*
 
 In case you are running along with a server set up, it is recommended to have 'mydbname' to be the same as the one on the server.
 
@@ -74,23 +75,19 @@ sudo apt install postgresql
 
 Set up the datasbase, in your shell swich to the postgres user and run psql, e.g.,
 ```bash
-sudo apt install postgresql
-```
-```bash
+sudo su - postgres
 psql
 ```
 
-Now, make the databases and users,
-
-Then set up a database and related users:
+Set up a database and related users:
 ```SQL
 CREATE USER myusername WITH PASSWORD 'mypasswd';
 CREATE DATABASE "mydbname";
 GRANT ALL PRIVILEGES ON DATABASE 'mydbname' TO 'myusername';
-\c mydbname
+\connect mydbname
 GRANT CREATE ON SCHEMA public TO 'myusername';
 ```
-Note: The last line is required since release 15 of Postgresql. It must be executed on the new database.
+*Note: The last line is required since release 15 of Postgresql. It must be executed on the new database.*
 
 The default install of postgress does not allow external connections. We can adjest this by typing
 ```bash