An open API service indexing awesome lists of open source software.

https://github.com/metabrainz/picard-docs

Documentation for MusicBrainz Picard
https://github.com/metabrainz/picard-docs

documentation musicbrainz musicbrainz-picard picard sphinx

Last synced: 2 months ago
JSON representation

Documentation for MusicBrainz Picard

Awesome Lists containing this project

README

          

# Documentation for MusicBrainz Picard

This project was created with the intent of eventually developing a comprehensive
user manual for [MusicBrainz Picard](https://picard.musicbrainz.org), a full-featured,
cross-platform music file tagging system using metadata from [MusicBrainz](https://musicbrainz.org).

This documentation project is open source and provided under CC0 1.0. To view a copy of this license,
visit [https://creativecommons.org/publicdomain/zero/1.0](https://creativecommons.org/publicdomain/zero/1.0).

The project currently produces the on-line documentation in [ReadTheDocs](https://readthedocs.org)
format theme using [Sphinx](https://www.sphinx-doc.org/). Stand-alone PDF and ePub documents are also being
produced. The latest build of the documentation produced by this initiative can be viewed on the
[web page](https://picard-docs.musicbrainz.org/).

## Contributing to the Documentation

This documentation project only exists because of the volunteer effort that goes into its development.

Further high quality contributions are welcomed from all Picard users wanting to be part of the
open source community that creates and maintains this valuable music tool. Even if you cannot
write code, based on your experience of using Picard any help you can give to improve this
documentation further will be most appreciated - and even if you cannot improve the existing help,
if you can create or maintain translations into other languages, that would be of great benefit.

If you notice an error in the documentation or have additional or updated material to contribute,
please create a [ticket](https://tickets.metabrainz.org/issues/?jql=project%20%3D%20PICARD%20AND%20component%20%3D%20Documentation%20AND%20status%20not%20in%20(Cancelled%2C%20Closed)%20ORDER%20BY%20status%20ASC%2C%20resolution%20DESC) under the Picard project (Documentation component).
[Pull Requests](https://github.com/metabrainz/picard-docs/pulls) to address outstanding issues are also
appreciated. Please see [CONTRIBUTING.md](https://github.com/metabrainz/picard-docs/blob/master/.github/CONTRIBUTING.md)
for more information and additional ways to contribute.

## Current Translation Progress

![Translation status](https://translations.metabrainz.org/widget/picard-docs/multi-auto.svg)