Readme: Attempt to switch from md to rst

Adding the type annotation to setup.py didn't seem to help. Lets see if
restructured text renders better than md.
This commit is contained in:
Simon Albinsson
2018-04-22 20:24:15 +00:00
parent ca59ea15cc
commit 33dec0df92
3 changed files with 15 additions and 6 deletions

View File

@@ -1,3 +1,7 @@
test:
python3 -m unittest discover
python2 -m unittest discover
uppload:
python setup.py sdist
twine upload dist/*

View File

@@ -1,9 +1,12 @@
# RPI_SGP30
RPI_SGP30
=========
Program to read eCO_2 and TVOC from the [SGP30 sensor](https://www.sensirion.com/fileadmin/user_upload/customers/sensirion/Dokumente/9_Gas_Sensors/Sensirion_Gas_Sensors_SGP30_Datasheet_EN.pdf). Based on the smbus2 i2c library for ease of use.
Quick usage-example:
Quick usage-example:
-------------------
::
from sgp30 import Sgp30
import time
@@ -22,12 +25,15 @@ Quick usage-example:
print()
print(sgp.read_measurements())
## Features that are known to be missing (listing in rough order of importance):
Features that are known to be missing (listing in rough order of importance):
---------------------------
* Fix python3 compatibility.
* The handing of baseline values are not that great, it should probably be up to the end user to save and restore them as needed.
* Write doc-strings for all or at least most methods.
* reading raw-values.
* A more "driver like" class that took care of all chip identification, polling intervals store baseline and so on.
Hardware notices:
-----------------
If you have the AdaFruit board with built in level shifters and voltage regulator it is should work if you just plug in [SDA to pin 3, SCL to pin 5, VCC to pin 17 and GND to pin 20](https://pinout.xyz/pinout/i2c). You should then be able to find the SGP30 an address 0x58 using `i2cdetect -y 1`. If you get an error message you probbably need to enable i2c in the kernel using [`raspi-config` and reboot](https://learn.sparkfun.com/tutorials/raspberry-pi-spi-and-i2c-tutorial)

View File

@@ -3,7 +3,7 @@
from setuptools import setup, find_packages
with open('README.md') as f:
with open('README.rst') as f:
readme = f.read()
with open('LICENSE') as f:
license = f.read()
@@ -11,9 +11,8 @@ with open('LICENSE') as f:
setup(
name='sgp30',
description='Library for reading data from the sensiron SGP30',
version='0.1.0',
version='0.1.2',
long_description=readme,
long_description_content_type='text/markdown',
author='Simon Albinsson',
author_email='pipmon@zinob.se',
url='https://github.com/zinob/RPI_SGP30',