Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
nvictus committed Aug 11, 2023
1 parent b3c77b9 commit 9447a0e
Showing 1 changed file with 18 additions and 5 deletions.
23 changes: 18 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,30 @@ Note: This project builds off our [previous work](https://github.com/NCBI-Codeat


## Installation
In your preferred Python (virtual) environment, run the following from the root of the cloned project: `pip install -e .`
In your preferred Python (virtual) environment, run the following from the root of the cloned project:
```sh
pip install -e .
```

You may also install from GitHub:
```sh
pip install git+https://github.com/abdenlab/VCFormer.git
```

We plan to publish to PyPI soon.


## Contribution
Install dev dependencies:
`pip install '.[dev]'`
```sh
pip install '.[dev]'
```

Install pre-commit:
`pip install pre-commit`
`pre-commit install`

```sh
pip install pre-commit
pre-commit install
```

## Usage
```python
Expand Down

0 comments on commit 9447a0e

Please sign in to comment.