Skip to content

Commit 2a4e69b

Browse files
committed
Add packaging information in README
1 parent e6436fa commit 2a4e69b

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,10 @@ USAGE
7272
## Installation
7373
After you downloaded *python-elitech*, no further installation steps are required
7474
as the (lightweight) dependences are provided as submodules for simplicity.
75+
You can also install the provided Wheel package using PIP
76+
```sh
77+
$ pip install path\to\package.whl
78+
```
7579

7680
Nevertheless, it is ***highly*** recommended that you add the [rules](60-elitech.rules)
7781
to `udev`. This can be done by simply copying (as root) this file
@@ -88,6 +92,14 @@ on my system, but any other existing group can be chosen by editing the file.
8892
This will enable a stadard user, provided he is a member of the `dialout` group,
8993
to access the device.
9094

95+
## Building
96+
The Wheel package and the source archive can be build using [Setuptools](https://setuptools.pypa.io)
97+
with the following command line
98+
```sh
99+
$ python -m build
100+
```
101+
in the directory where the `pyproject.toml` file is.
102+
91103
## CLI
92104
The CLI interface can be invoked using `python elitech [command]`
93105
in the project root directory (which contains this README).

0 commit comments

Comments
 (0)