beets/docs/index.rst
2023-10-27 21:55:13 +10:00

43 lines
1.2 KiB
ReStructuredText

beets: the music geek's media organizer
=======================================
Welcome to the documentation for `beets`_, the media library management system
for obsessive music geeks.
If you're new to beets, begin with the :doc:`guides/main` guide. That guide
walks you through installing beets, setting it up how you like it, and starting
to build your music library.
Then you can get a more detailed look at beets' features in the
:doc:`/reference/cli/` and :doc:`/reference/config` references. You might also
be interested in exploring the :doc:`plugins </plugins/index>`.
If you still need help, you can drop by the ``#beets`` IRC channel on
Libera.Chat, drop by `the discussion board`_, send email to
`the mailing list`_, or `file a bug`_ in the issue tracker. Please let us know
where you think this documentation can be improved.
.. _beets: https://beets.io/
.. _the mailing list: https://groups.google.com/group/beets-users
.. _file a bug: https://github.com/beetbox/beets/issues
.. _the discussion board: https://github.com/beetbox/beets/discussions/
Contents
--------
.. toctree::
:maxdepth: 2
guides/index
reference/index
plugins/index
faq
team
contributing
code_of_conduct
dev/index
.. toctree::
:maxdepth: 1
changelog