Update installation instructions

The easiest way to install is arguably by using pip, so recommend that.
This commit is contained in:
Grigori Goronzy 2018-09-06 21:54:09 +02:00 committed by GitHub
parent b0e882ff32
commit 83c0b47f62
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -3,8 +3,16 @@ Installation
stcgal requires Python 3.2 (or later) and pySerial. USB support is stcgal requires Python 3.2 (or later) and pySerial. USB support is
optional and requires pyusb 1.0.0b2 or later. You can run stcgal optional and requires pyusb 1.0.0b2 or later. You can run stcgal
directly with the included ```stcgal.py``` script. The recommended directly with the included ```stcgal.py``` script if the dependencies
method for permanent installation is to use Python's setuptools. Run are already installed.
```./setup.py build``` to build and ```sudo ./setup.py install```
to install stcgal. A permanent installation provides the ```stcgal``` There are several options for permanent installation:
command.
* Use Python3 and ```pip```. Run
```pip3 install git+https://github.com/grigorig/stcgal.git```
to install the latest version of stcgal globally on your system.
This may require administrator/root permissions for write access
to system directories.
* Use setuptools. Run ```./setup.py build``` to build and
```sudo ./setup.py install``` to install stcgal.