Skip to content

Add man pages#17

Merged
jasger9000 merged 5 commits intomainfrom
add_man_pages
Jun 20, 2025
Merged

Add man pages#17
jasger9000 merged 5 commits intomainfrom
add_man_pages

Conversation

@jasger9000
Copy link
Owner

This PR rewrites some sections of the README and sample config and adds two man pages for the config and the main application.

Detailed changes:

  • Change every instance of mpDris to mpdris including URLs (not a breaking change since GitHub URLs are case insensitive)
  • Rewrite the section on covers in the README to better explain cover searching
  • Remove information on cover searching from the sample config, redirecting them to the README or man pages
  • Fix some small grammar issues
  • Add two man pages: mpdris.1 and mpdris.conf.5

Since the package in Cargo.toml and the AUR is called mpdris it doesn't
make much sense to make the actual name of the application mpDris,
especially since every other file is also all lowercase.
Rewrite the cover section of the README to better explain how mpdris
searches for covers.
add two man pages to document mpdris itself and mpdris.conf
rewrite the cover_directory and music_directory sections of the config,
removing the information on cover searching, and directing users to the
README or man page.
This is just to make me not having to write documentation for one
feature three times in different formats.
@jasger9000 jasger9000 merged commit b39a886 into main Jun 20, 2025
3 checks passed
@jasger9000 jasger9000 deleted the add_man_pages branch June 20, 2025 12:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant