Skip to content

Commit 5b39943

Browse files
committed
Better readme install directions
1 parent 49d4d34 commit 5b39943

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

README.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,22 @@ Requires Python version 3.6 or greater
3636
### Upcoming/Planned Features
3737
* NI-XNET (CAN) USB adapter support
3838
* Ethernet (TCPIP/UDP) support
39-
39+
## Installation
40+
Install the package by saving the .whl file from the project releases page https://github.com/BloomyControls/BS1200-Python-Driver/releases/
41+
Open command line, powershell, or another terminal to the location the .whl file was saved and run the following command to install using pip package manager
42+
Windows:
43+
```
44+
pip install "\path\to\whl\file\BS1200_driver-X.X.X-py3-none-any.whl"
45+
```
46+
Linux:
47+
```
48+
pip3 install "/path/to/whl/file/BS1200_driver-X.X.X-py3-none-any.whl"
49+
```
50+
Alternative to downloading a release, the library may be built to the project /dist/ directory by running the command
51+
```
52+
python -m build
53+
```
54+
from the same directory the project's pyproject.toml file is found, and install using pip from the freshly built .whl in the /dist/ directory.
4055
## Use Instructions
4156
Once the package has been installed to the python environment, the `BS1200` driver class may be used to communicate action statuses with target BS1200 units over a PCAN adapter, or to configure settings for a BS1200 at a designated IP address using the `ConfigTools` class.
4257
### BS1200 (driver)

0 commit comments

Comments
 (0)