generated from PlexSheep/baserepo
Compare commits
2 commits
a9bb35c2ba
...
c2064beae3
Author | SHA1 | Date | |
---|---|---|---|
c2064beae3 | |||
4a7aade4fc |
2 changed files with 12 additions and 4 deletions
|
@ -9,7 +9,7 @@ readme = "README.md"
|
|||
homepage = "https://git.cscherr.de/PlexSheep/pt"
|
||||
repository = "https://git.cscherr.de/PlexSheep/pt"
|
||||
keywords = ["cli", "python", "scriptable", "pyo3", "library"]
|
||||
categories = ["command-line-utilities"]
|
||||
categories = ["command-line-utilities", "development-tools", "development-tools::ffi"]
|
||||
|
||||
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
|
||||
|
||||
|
|
14
README.md
14
README.md
|
@ -16,17 +16,25 @@ So what? I don't care. Besides, there is not enough names to name everything uni
|
|||
- [`maturin`](https://maturin.rs) - `pip install maturin`
|
||||
|
||||
## Compiling & Installing from source
|
||||
If you only want the rust library, you can simply build it with `cargo build`.
|
||||
If you only want the rust library, you can simply build it with `cargo build`. Add it to your
|
||||
project like any other local dependency.
|
||||
|
||||
If you want to use the python variant too, you need to compile with maturing.
|
||||
|
||||
- Install in `venv`: `maturin develop --release`
|
||||
- Install in system: `maturin build --release && pip install target/wheels/libpt-x.x.x-*`
|
||||
|
||||
## Installing from [crates.io](https://crates.io)
|
||||
`libpt` has not yet been packaged for [crates.io](https://crates.io).
|
||||
`libpt` has been packaged for [crates.io](https://crates.io/crates/libpt).
|
||||
|
||||
You can add the library to your project with `cargo add libpt`.
|
||||
|
||||
## Installing from my personal package registry
|
||||
`libpt` has not yet been packaged for [git.cscherr.de](https://git.cscherr.de).
|
||||
`libpt` has been packaged for [git.cscherr.de](https://git.cscherr.de).
|
||||
|
||||
You can add the registry to your `config.toml` and then `cargo add libpt`
|
||||
|
||||
[Package](https://git.cscherr.de/PlexSheep/-/packages/cargo/libpt/)
|
||||
|
||||
## Testing
|
||||
Testing needs to be done separately for the rust and python parts:
|
||||
|
|
Reference in a new issue