From 6835279c59c10a22088ab5fcf7227873c808cb14 Mon Sep 17 00:00:00 2001
From: Christian Darsow-Fromm <christian.darsow@physik.uni-hamburg.de>
Date: Fri, 8 Mar 2019 12:01:33 +0100
Subject: [PATCH] doc install updates closes #194
---
doc/install.md | 27 +++++++--------------------
1 file changed, 7 insertions(+), 20 deletions(-)
diff --git a/doc/install.md b/doc/install.md
index 28314ef..38da1d7 100644
--- a/doc/install.md
+++ b/doc/install.md
@@ -16,36 +16,21 @@ Then, you can install
### Using PyPi (recommended)
This is the recommended, easiest version to install nqontrol.
-It is not fully optimized and on a local repository and needs some extra flags for now.
-And for now it is only available from the Uni Hamburg network.
```bash
-pip3 install --upgrade --user --extra-index-url https://las-nq-serv.physnet.uni-hamburg.de/pypiserver/ nqontrol
+pip3 install --upgrade --user nqontrol
```
If you don't have `pip3` on your system, try `pip`.
-To install system wide don't use the `--user` flag.
-
-### Make extra Host permanent
-If you want to add our pip repository permanently to your Unix system, save the following to the pip configuration file `~/.pip/pip.conf`:
-```ini
-[global]
-extra-index-url = https://las-nq-serv.physnet.uni-hamburg.de/pypiserver/
-```
-
+To install system-wide don't use the `--user` flag.
### Other Sources
Here you can get the newest stable version:
-* **[nqontrol software builds](https://las-nq-serv.physnet.uni-hamburg.de/software-builds/nqontrol/)**
* **[gitlab repository](https://gitlab.rrz.uni-hamburg.de/las-nq/nqontrol)**
More distribution methods will follow.
-### All systems (general solution)
-
-Unpack the `*.tar.gz` or download the source from gitlab.
-
-#### Install dependencies
+#### Install Dependencies for Development
To install the dependencies on a Unix system, use:
```bash
@@ -56,7 +41,7 @@ The general version for the only non-Unix system is:
pip install --user -r requirements.txt
```
-#### Install nqontrol
+#### Install NQontrol
The pythonic installation to the users site packages is done with:
```bash
@@ -73,7 +58,9 @@ Maybe it needs little work to install them automatically.
### On Linux
The ADwin connects via a fixed LAN connection, which has to be configured first.
-Afterwards, in the repository, navigate to the `env` folder, unpack the `adwin-lib-*-.tar.gz`. Navigate to the `adwin-lib` folder and read INSTALL.
+Download the library from the [ADwin file server](https://www.adwin.de/pub/cd/):
+
+[adwin-lib-5.0.12](https://www.adwin.de/pub/cd/adwin-lib-5.0.12.tar.gz)
TL;DR:
```bash
--
GitLab