From a25bf40a5b812e172cb1183d87866b8bb79049e4 Mon Sep 17 00:00:00 2001
From: PlexSheep <software@cscherr.de>
Date: Sat, 8 Jul 2023 15:01:22 +0200
Subject: [PATCH] readme update

---
 README.md | 36 +++++++++++++++++++++++++++---------
 1 file changed, 27 insertions(+), 9 deletions(-)

diff --git a/README.md b/README.md
index 51e6393..bcd610c 100644
--- a/README.md
+++ b/README.md
@@ -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!
 So what? I don't care. Besides, there is not enough names to name everything unique.
 
-# compiling
-TBD
+## Dependencies
+- See `cargo.toml`
+- [Python](https://www.python.org/)
+- [`maturin`](https://maturin.rs) - `pip install maturin`
 
-# installing
-TBD
+## Compiling & Installing from source
+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
-TBD
+- Install in `venv`: `maturin develop --release`
+- 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)
 
 It is mirrored to:
@@ -27,5 +45,5 @@ It is mirrored to:
 - [Codeberg](https://codeberg.org/PlexSheep/pt)
 
 
-# License
-GPL-3 or newer.
+## License
+##### GPL-3 or newer.