Skip to content

Commit

Permalink
DOC: Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Vini2 committed Apr 24, 2024
1 parent d75917b commit 714702d
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
[![Anaconda-Server Badge](https://anaconda.org/bioconda/metacoag/badges/downloads.svg)](https://anaconda.org/bioconda/metacoag)

[![CI](https://github.com/metagentools/MetaCoAG/actions/workflows/testing_python.yml/badge.svg)](https://github.com/metagentools/MetaCoAG/actions/workflows/testing_python.yml)
[![Coverage Status](https://coveralls.io/repos/github/metagentools/MetaCoAG/badge.svg?branch=develop)](https://coveralls.io/github/metagentools/MetaCoAG?branch=develop)
![GitHub](https://img.shields.io/github/license/Vini2/MetaCoAG)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![CodeQL](https://github.com/metagentools/MetaCoAG/actions/workflows/codeql.yml/badge.svg)](https://github.com/metagentools/MetaCoAG/actions/workflows/codeql.yml)
Expand Down Expand Up @@ -93,14 +94,21 @@ You can run the following command to install MetaCoAG using `pip`. Make sure you
pip install .
```

**Note:** If you use pip to setup MetaCoAG for development, you will have to install [FragGeneScan](https://sourceforge.net/projects/fraggenescan/) and [HMMER](http://hmmer.org/) manually and add them to your system path.
### Using `flit`
You can run the following command to install MetaCoAG using `flit`. Make sure you are in the MetaCoAG folder.

```
flit install
```

**Note:** If you use pip or flit to setup MetaCoAG for development, you will have to install [FragGeneScan](https://sourceforge.net/projects/fraggenescan/) and [HMMER](http://hmmer.org/) manually and add them to your system path.

### Test the setup

After setting up, run the following command to ensure that metacoag is working.

```
metacoag -h
metacoag --help
```

## Example Usage
Expand Down

0 comments on commit 714702d

Please sign in to comment.