Browse Source

Update README.md

Patrick Schreiber 6 years ago
parent
commit
e0f5cc24a2
1 changed files with 24 additions and 6 deletions
  1. 24 6
      README.md

+ 24 - 6
README.md

@@ -4,16 +4,34 @@ KCG is the Graphical Control Interface to the KAPTURE-Readout-Board.
 
 ## Prerequisites:
 
+(Windows support is not tested)
+
+### Must be installed by system packagemanager
+
 - python 2.7.x
-- PyQt4 (python-qt)
+- PyQt4
+
+To install on debian e.g.:
+
+- sudo apt-get install python
+- sudo apt-get install python-qt4
+
+### Will be installed via installing of KCG (if will be installed else those have to be installed seperately)
+
 - pyqtgraph
 - numpy
 
+To manually install them use e.g. pip:
+
+- pip install pyqtgraph
+- pip install numpy
+
 ## Download
 
 #### Stable Version
 
-To get the latest stable version get the latest release from [here](https://psraspi.no-ip.biz/gogs/calipp/KCG/releases)
+To get the latest stable version get the latest release from [here](https://git.lycab.de/KIT/KCG/releases)
+
 #### Development Version
 
 To get the latest development Version clone this repository 
@@ -29,8 +47,8 @@ You can install KCG or run without intstallation
 
 ### Install
 
-To install KCG (either system- or userwide) use `python setup.py install` with optionally `--user` as flag to install only for current user.  
-To start KCG after installation simply run `kcg` from whereever you are.  
+To install KCG (either system- or userwide) use (inside the repository) `pip install .` with optionally `--user` as flag to install 
+only for current user.  To start KCG after installation simply run `kcg` from whereever you are.  
 Upon first run you will be prompted to configure KCG this will set appropriate values and write them to ~/.kcg/config.cfg  
 
 #### NOTE: 
@@ -38,11 +56,11 @@ If you chose to install for current user only you need to have $HOME/.local/bin
 
 ### Run without installation
 
-You can run KCG directly without installation. To do so, simply run kcg in the outer KCG directory.
+You can run KCG directly without installation. To do so, simply run `./kcg` in the outer KCG directory.
     You will still be asked to configure KCG if it is the first run.
 
 
 ### Unintentional Features
-If you find any unintentional features (bugs) or have questions please let me know via [issues](https://psraspi.no-ip.biz/gogs/calipp/KCG/issues).
+If you find any unintentional features (bugs) or have questions please let me know via [issues](https://git.lycab.de/KIT/KCG/issues).