Skip to content

Commit

Permalink
Final README edits for release
Browse files Browse the repository at this point in the history
  • Loading branch information
JOJ0 committed Dec 30, 2024
1 parent fc3c83c commit da9447f
Showing 1 changed file with 20 additions and 18 deletions.
38 changes: 20 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,37 +11,39 @@ D i s c o / / / - The record collector's toolbox
DiscoDOS is a set of command line tools for DJ's and record collectors.

- It's based on data pulled from a user's [Discogs](https://www.discogs.com) record [collection](https://support.discogs.com/hc/en-us/articles/360007331534-How-Does-The-Collection-Feature-Work-).
- [List records for sale](https://discodos.readthedocs.io/en/sell/MANUAL.html#the-sell-command) on the Discogs Marketplace.
- [Edit existing Marketplace listings](https://discodos.readthedocs.io/en/sell/MANUAL.html#the-ls-tui-command) using a self-explanatory _TUI_ interface.
- Metadata of DJ sets can be recorded and analyzed to feed a simple ["suggestion" mechanism](https://discodos.readthedocs.io/en/sell/MANUAL.html#the-suggest-command).
- [Organize tracks into playlists](https://discodos.readthedocs.io/en/sell/MANUAL.html#the-mix-command) and rate mix-transitions.
- Link the collection to [MusicBrainz](https://musicbrainz.org) and [AcousticBrainz](https://acousticbrainz.org), to provide key and BPM data of tracks. These features are deprecated but still work partly - [read more about it here](https://discodos.readthedocs.io/en/sell/MANUAL.html#acousticbrainz-support-is-deprecated).
- [List records for sale](https://discodos.readthedocs.io/en/latest/MANUAL.html#the-sell-command) on the Discogs Marketplace.
- [Edit existing Marketplace listings](https://discodos.readthedocs.io/en/latest/MANUAL.html#the-ls-tui-command) using a self-explanatory _TUI_ interface.
- Metadata of DJ sets can be recorded and analyzed to feed a simple ["suggestion" mechanism](https://discodos.readthedocs.io/en/latest/MANUAL.html#the-suggest-command).
- [Organize tracks into playlists](https://discodos.readthedocs.io/en/latest/MANUAL.html#the-mix-command) and rate mix-transitions.
- Link the collection to [MusicBrainz](https://musicbrainz.org) and [AcousticBrainz](https://acousticbrainz.org), to provide key and BPM data of tracks. These features are deprecated but still work partly - [read more about it here](https://discodos.readthedocs.io/en/latest/MANUAL.html#acousticbrainz-support-is-deprecated).

DiscoDOS is a command line tool, though [parts of it provide a TUI - a _text user interface_](https://discodos.readthedocs.io/en/sell/MANUAL.html#the-ls-tui-command). DiscoDOS is written in Python and runs on Linux, macOS and Windows.
DiscoDOS is a command line tool, though [parts of it provide a TUI - a _text user interface_](https://discodos.readthedocs.io/en/latest/MANUAL.html#the-ls-tui-command). DiscoDOS is written in Python and runs on Linux, macOS and Windows.

<!-- omit in toc -->
##### Viewing mix details, searching and adding track:
### Viewing Marketplace stats and edit listings, fetching videos, and more
![dsc ls full screen](sphinx/source/_static/ls-default-full-screen.png)

### Selling a record
![dsc sell](sphinx/source/_static/sell.gif)

### Viewing mix details, searching and adding track:
![demo gif 1](assets/intro_gif_v0.4_1-580_16col_960x581.gif)
<!-- omit in toc -->
##### Updating track information from Discogs and MusicBrainz/AcousticBrainz:
![demo gif 2](assets/intro_gif_v0.4_580-end_16col_960x581.gif)

### Updating track information from Discogs and MusicBrainz/AcousticBrainz:
![demo gif 2](assets/intro_gif_v0.4_580-end_16col_960x581.gif)

Video Tutorials
_The latter two videos are slightly outdated. DiscoDOS' main command now is called `dsc` and AcousticBrainz as an actual website not existing anymore (API-only, which DiscoDOS makes use of._
### Video Tutorials

- [How to use DiscoDOS #1 - Mixes, Suggestions, Collection, AcousticBrainz](https://www.youtube.com/watch?v=c9lqKuGSCVk&list=PLcHqk0rpp8bprmYlaXdrs6pbOpPoJwW-T)
- [How to use DiscoDOS #2 - Finding key & BPM compatible tracks](https://www.youtube.com/watch?v=agp9OrYC66I&list=PLcHqk0rpp8bprmYlaXdrs6pbOpPoJwW-T&index=3)
- [How to use DiscoDOS #3 - Fetch key & BPM from AcousticBrainz](https://www.youtube.com/watch?v=4lungDgdJ2w&list=PLcHqk0rpp8bprmYlaXdrs6pbOpPoJwW-T&index=4)


Head over to the documentation pages and learn how to install and
use DiscoDOS:
### Docs

- [Quickstart Guide](https://discodos.readthedocs.io/en/latest/QUICKSTART.html)
- [Installaton Guide](https://discodos.readthedocs.io/en/latest/INSTALLATION.html)
- [Setup Guide](https://discodos.readthedocs.io/en/latest/INSTALLATION.html)
- [User's Manual](https://discodos.readthedocs.io/en/latest/MANUAL.html)


View the DiscoDOS website:
### Website

- [discodos.jojotodos.net](https://discodos.jojotodos.net)

0 comments on commit da9447f

Please sign in to comment.