Skip to content

Commit

Permalink
add rust info to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Esgrove committed Jan 30, 2024
1 parent 1f64046 commit b803b2c
Showing 1 changed file with 20 additions and 5 deletions.
25 changes: 20 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,26 @@
# Track Renamer

CLI tool for formatting and renaming audio files.
Originally made in Python,
and now contains a Rust version as well.

## Dependencies
## Python version

### Dependencies

- Python 3.11+
- [Poetry](https://github.com/python-poetry/poetry)

Install Python packages:

```shell
poetry install
```

## Usage
### Usage

Run with poetry script or directly:

```shell
poetry run rename --help
poetry run python rename/renamer.py --help
Expand All @@ -38,12 +44,21 @@ Options:

See the [test data](./tests/test_data.py) for formatting examples.

## Tests
### Tests

```shell
poetry run pytest -v --cov=rename tests/
```

## TODO
## Rust version

- Finish Rust version
```shell
./build.sh
./install.sh
```

### Run tests

```shell
cargo test
```

0 comments on commit b803b2c

Please sign in to comment.