Update README.md

rusteomics · Oct 21, 2023 · faa5df9 · faa5df9
1 parent 3687709
commit faa5df9
Showing 1 changed file with 15 additions and 2 deletions.
diff --git a/mzio-py/README.md b/mzio-py/README.md
@@ -1,3 +1,16 @@
-# mzio-py
+# Python bindings of rusteomics-proteomis-io
 
-Python bindings for reading and writing utilities for mass spectrometry in Rust.
+## Install
+Needs to be published   
+`pip install rusteomics_proteomics_io_py`
+
+## Install dependencies for development
+1. Install (Ana|mini){0,1}conda
+2. `conda env create -f environment.yaml`
+3. `conda activate rusteomics_proteomics_io`
+
+## Build
+`maturin develop` (or `build`)
+
+## Testing
+`python -m unittest`