diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fa753f2..49aa709 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -25,7 +25,15 @@ cd kmertools Now build kmertools using cargo. Make sure to have [`rust`](https://docs.conda.io/en/latest/) installed. ```shell +# to build the kmertools cli app cargo build +# to build the python wheels +# pip +cd pip +maturin build --release +# conda +cd conda +maturin build --release ``` ## Test kmertools build @@ -36,6 +44,16 @@ Use the following command to test the build. All tests should pass. cargo test ``` +To test the python bindings, change directory to either `conda` or `pip` then run following commands. + +```shell +cd pip # or cd conda +maturin develop +# go to tests folder +cd ../tests +pytest -s +``` + ## Coding Style We use [Clippy](https://doc.rust-lang.org/clippy/) to lint code in kmertools. diff --git a/README.md b/README.md index 9b2bdf3..66f05db 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # kmertools: DNA Vectorisation Tool -![GitHub License](https://img.shields.io/github/license/anuradhawick/kmertools) +[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) [![Cargo tests](https://github.com/anuradhawick/kmertools/actions/workflows/rust_test.yml/badge.svg)](https://github.com/anuradhawick/kmertools/actions/workflows/rust_test.yml) [![Clippy check](https://github.com/anuradhawick/kmertools/actions/workflows/clippy_check.yml/badge.svg)](https://github.com/anuradhawick/kmertools/actions/workflows/clippy_check.yml) [![install with bioconda](https://img.shields.io/badge/install%20with-bioconda-brightgreen.svg?style=flat)](http://bioconda.github.io/recipes/kmertools/README.html)