Skip to content

Commit 5d2cc2c

Browse files
committed
Add installation instructions and finalize for v0.2.0
1 parent fe4e06d commit 5d2cc2c

4 files changed

Lines changed: 44 additions & 9 deletions

File tree

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,25 @@
1111
|Mac 3.10-3.13|[![CI: Run Tests on MacOS](https://github.com/MatrixEditor/icspacket/actions/workflows/ci-pytest-macos.yml/badge.svg)](https://github.com/MatrixEditor/icspacket/actions/workflows/ci-pytest-macos.yml)|
1212
|Windows 3.10-3.13|[![CI: Run Tests on Windows](https://github.com/MatrixEditor/icspacket/actions/workflows/ci-pytest-windows.yml/badge.svg)](https://github.com/MatrixEditor/icspacket/actions/workflows/ci-pytest-windows.yml)|
1313

14+
## Installation
15+
16+
There are pre-built wheels on PyPI for Python 3.10 to 3.13 for Linux, Windows
17+
and MacOS. Any other Python version is not officially supported.
18+
19+
```bash
20+
pip install icspacket
21+
```
22+
23+
Alternatively, to build from source, Python development headers, CMake, Ninja
24+
and a compatible compiler must be installed (preferably GCC, MSVC and clang work
25+
too).
26+
27+
```bash
28+
pip install git+https://github.com/MatrixEditor/icspacket
29+
```
30+
31+
32+
1433
## License
1534

1635
Distributed under the GNU General Public License (V3). See [License](LICENSE) for more information.

docs/source/getting-started/installation.rst

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,26 @@
33
Installation
44
============
55

6-
*WIP*
6+
There are pre-built wheels on PyPI for Python 3.10 to 3.13 for Linux, Windows
7+
and MacOS. Any other Python version is not officially supported::
78

8-
.. note::
9+
pip install icspacket
910

10-
For development, Python headers must be available.
11+
Alternatively, to build from source, Python development headers, CMake, Ninja
12+
and a compatible compiler must be installed (preferably GCC, MSVC and clang work
13+
too)::
14+
15+
pip install "git+https://github.com/MatrixEditor/icspacket"
16+
17+
18+
19+
.. tip::
20+
21+
For development and debugging, there are additional compile time options.
22+
Take a look at ``pyproject.toml`` or add the following line to the
23+
``CMakeLists.txt``::
24+
25+
add_definitions(-DASN_EMIT_DEBUG=1)
26+
27+
Be aware that there will be A LOT of textual output if you enable this extra
28+
logging feature.

docs/source/index.rst

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,10 @@ icspacket
2222
Getting Started
2323
---------------
2424

25-
Installation requires Python development headers, CMake, Ninja and a C compiler
26-
(preferrably GCC).
25+
There are pre-built wheels on PyPI for Python 3.10 to 3.13 for Linux, Windows
26+
and MacOS. Any other Python version is not officially supported::
2727

28-
.. code-block:: bash
29-
30-
pip install git+https://github.com/MatrixEditor/icspacket
28+
pip install icspacket
3129

3230

3331
.. toctree::

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ GitHub = "https://github.com/MatrixEditor/icspacket"
5959
[tool.scikit-build.cmake]
6060
# NOTE: To enable extra debugging output at runtime you might also add
6161
# -DASN_EMIT_DEBUG=1 as a compile-time define.
62-
# build-type = "Debug"
62+
build-type = "Debug"
6363

6464
# --- Dynamic Version scheme
6565
[tool.scikit-build]

0 commit comments

Comments
 (0)