Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
hejops committed Feb 3, 2024
1 parent 8cf52f4 commit 158b20e
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@

A command-line interface for automated mp3 file tagging using data from
[Discogs](http://www.discogs.com/), inspired by the
[foo_discogs](https://bitbucket.org/zoomorph/foo_discogs/src/master/)
component for [foobar2000](http://www.foobar2000.org/).
[foo_discogs](https://bitbucket.org/zoomorph/foo_discogs/src/master/) component
for [foobar2000](http://www.foobar2000.org/).

# About
## About

Goals set out in the development of the project include:

Expand All @@ -23,7 +23,7 @@ probably has similarities to that of [the joalla team's
client](https://github.com/joalla/discogs_client), exposing it to the user has
not been the primary objective of the project.

# Installation
## Installation

First, generate a [Discogs API token](https://www.discogs.com/settings/developers).

Expand All @@ -33,19 +33,19 @@ cd dita
pip install -r requirements.txt
```

# Usage
## Usage

Scripts that you will probably want to use include:

1. [`tagfix.py`](./tagfix.py) -- tag MP3 files
1. [`mover.py`](./file/mover.py) -- move files to a central location
1. [`convert.py`](./file/convert.py) -- convert most audio codecs to MP3
1. [`play.py`](./play/pmp.py) -- play music
1. [`fix.py`](./dita/tag/fix.py) -- tag MP3 files
1. [`mover.py`](./dita/file/mover.py) -- move files to a central location
1. [`convert.py`](./dita/file/convert.py) -- convert most audio codecs to MP3
1. [`pmp.py`](./dita/play/pmp.py) -- play music

Exploring the rest of the codebase is an exercise left to the reader. Most
important methods are at least decently documented.

# Contributing
## Contributing

If you find any issues or need any help, please file an
[issue](https://github.com/hejops/dita/issues). [Pull
Expand Down

0 comments on commit 158b20e

Please sign in to comment.