xmpd/DEV.md
MCorange 31a710c6cb
Add licensing, readme, todo file
Fix the cursor showing as the 'edit text' type when hovering over a
playlist in the side nav bar
2024-10-10 02:13:49 +03:00

73 lines
2.0 KiB
Markdown

# Developer notes
## TODO'S
Todo types:
[FEAT] \[loc\](/src/...) - Feature, mandatory location
[BUG] \[loc\](/src/...) - Bugfix, mandatory location
[GIT] \[loc\](/src/...) - Git related feature, optional location
Fixed todos have to add `**DONE**` prefix to the type
### #0
[FEAT] - [side_nav](/src/ui/gui/components/side_nav.rs)
Add dropdown menu for `side_nav` playlist
### #1
[FEAT] - [gui](/src/ui/gui/)
Move theme selection to a settings panel
### #2
[FEAT] - [gui](/src/ui/gui/)
Better styling
### #3
[FEAT] - [gui](/src/ui/gui/)
Add music player footer
### #4
[FEAT] - [gui](/src/ui/gui/components/song_list.rs)
Add numbers to `song_list` table
### #5
[FEAT] - [NEW](/src/)
Add music player logic
### #6
[FEAT] - [manifest](/src/manifest/)
Add support for images by possibly storing the images in json or custom format
### #7
[FEAT] - [*global*](/src/)
Transition application into a globally installed application by default from a
standalone one, moving default paths and using [#10](#10):
| Type | Unix path | Windows path |
|--------------|--------------------------------|--------------------------------|
| config | `~/.config/mcmg/config.json` | `%AppData%/mcmg/config.json` |
| manifest | `~/.config/mcmg/manifest.json` | `%AppData%/mcmg/manifest.json` |
| music-output | `~/Music/mcmg/*` | `%userprofile%/Music/mcmg/*` |
### #8
[FEAT] - [cli](/src/ui/cli/)
add missing commands that are available via gui
- Downloading single songs, from the manifest and standalone as an utility
### #9
[BUG] - [utils](/src/util.rs)
Fix `isatty` not working correctly on windows
### #10
[FEAT] - [utils](/src/util.rs)
Add an utility to detect if this is ran as a standalone application
### #11
[FEAT] - [downloader](/src/downloader.rs)
Refractor for better readability and usage
### #12
[GIT]
Add ci that runs clippy and builds in release mode
Constant todos:
TODO: Run code through clippy and fix any errors