From 1f89c8b7bbd3805a06ab679b11954f41c4ae0b2f Mon Sep 17 00:00:00 2001 From: PlexSheep Date: Thu, 20 Jul 2023 22:13:25 +0200 Subject: [PATCH] reformat readme --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index c56f50f..014ea8d 100644 --- a/README.md +++ b/README.md @@ -8,15 +8,18 @@ crate, python module or executable. Let's see if I make it a bloated mess or stop committing after 30 hello worlds. #### But the name `pt` / `libpt` already exists! + So what? I don't care. Besides, there is not enough names to name everything unique. ## Dependencies + - See `cargo.toml` - [openssl bindings for rust](https://docs.rs/openssl/latest/openssl/) - [Python](https://www.python.org/) - [`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`. Add it to your project like any other local dependency. @@ -26,16 +29,19 @@ If you want to use the python variant too, you need to compile with maturing. - Install in system: `maturin build --release && pip install target/wheels/libpt-x.x.x-*` ## Installing from [pypi](https://pypi.org) + `libpt` has been packaged for [pypi.org](https://pypi.org/project/libpt/). You can install it with `pip install libpt` ## Installing from [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 been packaged for [git.cscherr.de](https://git.cscherr.de). You can add the registry to your `config.toml` and then `cargo add libpt` @@ -43,17 +49,20 @@ 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: - 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`. An up to date version of the Documentation can be found [here](https://docs.rs/libpt/) ## Mirrored + The origin of this repository is [git.cscherr.de](https://git.cscherr.de/PlexSheep/pt) It is mirrored to: @@ -61,4 +70,5 @@ It is mirrored to: ## License + ##### GPL-3 or newer.