Skip to content

Commit a2954ef

Browse files
committed
Prep for v1.0.0.
1 parent db87533 commit a2954ef

File tree

3 files changed

+24
-13
lines changed

3 files changed

+24
-13
lines changed

CHANGELOG.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
1.0.0
2+
-----
3+
4+
* Repackage to hatch/pyproject.toml
5+
16
0.0.1
27
-----
38

README.md

Lines changed: 18 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -5,25 +5,31 @@
55
[![PyPi Package](https://img.shields.io/pypi/v/icp10125.svg)](https://pypi.python.org/pypi/icp10125)
66
[![Python Versions](https://img.shields.io/pypi/pyversions/icp10125.svg)](https://pypi.python.org/pypi/icp10125)
77

8-
# Pre-requisites
98

10-
You must enable:
11-
12-
* i2c: `sudo raspi-config nonint do_i2c 0`
9+
# Installing
1310

14-
You can optionally run `sudo raspi-config` or the graphical Raspberry Pi Configuration UI to enable interfaces.
11+
If you've already set up a Python virtual environment, you can also install the stable library manually from PyPi:
1512

16-
# Installing
13+
```
14+
pip install icp10125
15+
```
1716

18-
Stable library from PyPi:
17+
Otherwise our install script will set one up for you.
1918

20-
* Just run `python3 -m pip install icp10125`
19+
Stable library from GitHub:
2120

22-
In some cases you may need to use `sudo` or install pip with: `sudo apt install python3-pip`
21+
```
22+
git clone https://github.com/pimoroni/icp10125-python
23+
cd icp10125-python
24+
./install.sh
25+
```
2326

2427
Latest/development library from GitHub:
2528

26-
* `git clone https://github.com/pimoroni/icp10125-python`
27-
* `cd icp10125-python`
28-
* `./install.sh --unstable`
29+
```
30+
git clone https://github.com/pimoroni/icp10125-python
31+
cd icp10125-python
32+
./install.sh --unstable
33+
```
2934

35+
**Note** Libraries will be installed in the "pimoroni" virtual environment, you will need to activate it to run examples:

icp10125/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
from smbus2 import SMBus, i2c_msg
55

6-
__version__ = "0.0.1"
6+
__version__ = "1.0.0"
77

88
NORMAL = 0x6825
99
LOW_POWER = 0x609C

0 commit comments

Comments
 (0)