Updated README

This commit is contained in:
Phil Howard
2019-01-21 11:50:30 +00:00
parent af5ebd1780
commit 8f17fa8673
4 changed files with 84 additions and 17 deletions

44
Makefile Normal file
View File

@@ -0,0 +1,44 @@
.PHONY: usage install uninstall
usage:
@echo "Usage: make <target>, where target is one of:\n"
@echo "install: install the library locally from source"
@echo "uninstall: uninstall the local library"
@echo "python-readme: generate library/README.rst from README.md"
@echo "python-wheels: build python .whl files for distribution"
@echo "python-sdist: build python source distribution"
@echo "python-clean: clean python build and dist directories"
@echo "python-dist: build all python distribution files"
install:
./install.sh
uninstall:
./uninstall.sh
python-readme: library/README.rst
python-license: library/LICENSE.txt
library/README.rst: README.md
pandoc --from=markdown --to=rst -o library/README.rst README.md
library/LICENSE.txt: LICENSE
cp LICENSE library/LICENSE.txt
python-wheels: python-readme python-license
cd library; python3 setup.py bdist_wheel
cd library; python setup.py bdist_wheel
python-sdist: python-readme python-license
cd library; python setup.py sdist
python-clean:
-rm -r library/dist
-rm -r library/build
-rm -r library/*.egg-info
python-dist: python-clean python-wheels python-sdist
ls library/dist
python-deploy: python-dist
twine upload library/dist/*

View File

@@ -5,30 +5,17 @@ Python library to control an ST7735 TFT LCD display. Allows simple drawing on t
Designed specifically to work with a ST7735 based 160x80 pixel TFT SPI display. (Specifically the 0.96" SPI LCD from Pimoroni).
For all platforms (Raspberry Pi and Beaglebone Black) make sure you have the following dependencies:
Make sure you have the following dependencies:
````
sudo apt-get update
sudo apt-get install build-essential python-dev python-smbus python-pip python-imaging python-numpy
sudo apt-get install python-rpi.gpio python-spidev python-pip python-imaging python-numpy
````
For a Raspberry Pi make sure you have the RPi.GPIO and Adafruit GPIO libraries by executing:
Install this library by running:
````
sudo pip install RPi.GPIO
sudo pip install Adafruit_GPIO
````
For a BeagleBone Black make sure you have the Adafruit_BBIO library by executing:
````
sudo pip install Adafruit_BBIO
````
Install the library by downloading with the download link on the right, unzipping the archive, navigating inside the library's directory and executing:
````
sudo python setup.py install
sudo pip install st7735
````
See example of usage in the examples folder.

36
library/README.rst Normal file
View File

@@ -0,0 +1,36 @@
Python ST7735 160x80
====================
Python library to control an ST7735 TFT LCD display. Allows simple
drawing on the display without installing a kernel module.
Designed specifically to work with a ST7735 based 160x80 pixel TFT SPI
display. (Specifically the 0.96" SPI LCD from Pimoroni).
Make sure you have the following dependencies:
::
sudo apt-get update
sudo apt-get install python-rpi.gpio python-spidev python-pip python-imaging python-numpy
Install this library by running:
::
sudo pip install st7735
See example of usage in the examples folder.
Pimoroni invests time and resources forking and slightly modifying this
open source code, please support Pimoroni and open-source software by
purchasing products from us, too!
Adafruit invests time and resources providing this open source code,
please support Adafruit and open-source hardware by purchasing products
from Adafruit!
Modified from 'Modified from 'Adafruit Python ILI9341' written by Tony
DiCola for Adafruit Industries.' written by Clement Skau.
MIT license, all text above must be included in any redistribution