Skip to content

Commit

Permalink
MAINT: Update build instructions and add test commands in contributio…
Browse files Browse the repository at this point in the history
…ns guideline
  • Loading branch information
anuradhawick committed Sep 26, 2024
1 parent c97b62d commit 9b401f6
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 1 deletion.
18 changes: 18 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -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)
Expand Down

0 comments on commit 9b401f6

Please sign in to comment.