introductory paragraphs

This commit is contained in:
Adrian Sampson 2011-09-17 16:02:06 -07:00
parent 521131bc2b
commit e013745f1c
5 changed files with 36 additions and 6 deletions

View file

@ -1,10 +1,12 @@
Guides
======
Tutorial stuff
This section contains a couple of walkthroughs that will help you get familiar
with beets. If you're new to beets, you'll want to begin with the :doc:`main`
guide.
.. toctree::
:maxdepth: 2
:maxdepth: 1
main
tagger

View file

@ -1,7 +1,10 @@
Getting Started
===============
TODO Intro Text
Welcome to `beets`_! This guide will help you begin using it to make your music
collection better.
.. _beets: http://beets.radbox.org/
Installing
----------

View file

@ -1,7 +1,24 @@
beets: the music geek's media organizer
=======================================
Intro text.
Welcome to the documentation for `beets`_, the media library management system
for obsessive-compulsive 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 :ref:`included-plugins`.
If you still need help, your can drop by the ``#beets`` IRC channel on Freenode,
`email the author`_, or `file a bug`_ in the issue tracker. Please let me know
where you think this documentation can be improved.
.. _beets: http://beets.radbox.org/
.. _email the author: mailto:adrian@radbox.org
.. _file a bug: http://code.google.com/p/beets/issues/entry
Contents
--------

View file

@ -3,7 +3,13 @@ Command-Line Interface
**beet** is the command-line interface to beets.
TODO: global flags
You invoke beets by specifying a *command*, like so::
beet COMMAND [ARGS...]
The rest of this document describes the available commands. If you ever need a
quick list of what's available, just type ``beet help`` or ``beet help COMMAND``
or help with a specific command.
import
------

View file

@ -1,7 +1,9 @@
Reference
=========
This section contains reference materials for various parts of beets.
This section contains reference materials for various parts of beets. To get
started with beets as a new user, though, you may want to read the
:doc:`/guides/main` guide first.
.. toctree::
:maxdepth: 2