readme update

This commit is contained in:
Christoph J. Scherr 2023-07-08 15:01:22 +02:00
parent d36b7c0d04
commit a25bf40a5b
Signed by: PlexSheep
GPG Key ID: 25B4ACF7D88186CC
1 changed files with 27 additions and 9 deletions

View File

@ -10,16 +10,34 @@ Let's see if I make it a bloated mess or stop committing after 30 hello worlds.
#### But the name `pt` / `libpt` already exists! #### But the name `pt` / `libpt` already exists!
So what? I don't care. Besides, there is not enough names to name everything unique. So what? I don't care. Besides, there is not enough names to name everything unique.
# compiling ## Dependencies
TBD - See `cargo.toml`
- [Python](https://www.python.org/)
- [`maturin`](https://maturin.rs) - `pip install maturin`
# installing ## Compiling & Installing from source
TBD If you only want the rust library, you can simply build it with `cargo build`.
If you want to use the python variant too, you need to compile with maturing.
# Documentation - Install in `venv`: `maturin develop --release`
TBD - Install in system: `maturin build --release && pip install target/wheels/libpt-x.x.x-*`
# Mirrored ## Installing from [crates.io](https://crates.io)
`libpt` has not yet been packaged for [crates.io](https://crates.io).
## Installing from my personal package registry
`libpt` has not yet been packaged for [git.cscherr.de](https://git.cscherr.de).
## Testing
Testing needs to be done separately for the rust and python parts:
- Rust testing with `cargo test`
- Python testing with `./scripts/pytests.sh` or `python -m unittest discover -fs tests/python`
## Documentation
The documentation can be automatically generated with `cargo doc --open`.
## Mirrored
The origin of this repository is [git.cscherr.de](https://git.cscherr.de/PlexSheep/pt) The origin of this repository is [git.cscherr.de](https://git.cscherr.de/PlexSheep/pt)
It is mirrored to: It is mirrored to:
@ -27,5 +45,5 @@ It is mirrored to:
- [Codeberg](https://codeberg.org/PlexSheep/pt) - [Codeberg](https://codeberg.org/PlexSheep/pt)
# License ## License
GPL-3 or newer. ##### GPL-3 or newer.