diff --git a/README.md b/README.md index 3e96f28..b3a0969 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,21 @@ # Oled-EInk-RaspberryPi -OLED and E-Paper on RaspberryPi - -A simple library with examples to use a Oled- or E-Ink-Display with RaspberryPi (Zero/2/3/4) \ No newline at end of file +OLED and E-Paper on RaspberryPi + +A simple library with examples to use a Oled- or E-Ink-Display with RaspberryPi (Zero/2/3/4) + +# Installation +To install the RPiGPIO.makertools library, you first have to clone the git repo: +``` +git clone https://git.privacynerd.de/dotmakertools/RPiGPIO.makertools.git +``` +After this is done, cd into RPiGPIO.makertools and type: +``` +python3 setup.py install +``` +This will copy the required package files to your python installation point (or, in case of a virtual environment, to the _lib_ directory of the env folder) and install all requirements. + +That's it! Now you can use the library in Python by importing it: +```python3 +import RPiGPIOmakertools +``` \ No newline at end of file