Update faq.rst

Thanks for the feedback! That's a lot clearer. I made the headers bold to ensure they still stood out as clear options if that's okay. Let me know if there are any other recommendations here.

I hit this issue -- https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=964245 -- while testing for another user and found the helpful guide but misread it a couple of times.

Thanks!
This commit is contained in:
Kyle R. Conway 2020-10-23 11:06:16 -05:00 committed by GitHub
parent 950dbe3b9f
commit d0cbf098c6
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -135,18 +135,20 @@ it's helpful to run on the "bleeding edge". To run the latest source:
1. Uninstall beets. If you installed using ``pip``, you can just run
``pip uninstall beets``.
2. Install from source. There are a few easy ways to do this:
2. Install from source. Choose **one** of the following methods:
- **Option 1** - Use ``pip`` to install the latest snapshot tarball:
- **Use ``pip`` to install the latest snapshot tarball:**
just type: ``pip install https://github.com/beetbox/beets/tarball/master``.
- **Option 2** - Grab the source using Git:
- **Grab the source using Git:**
1. First clone the repository ``git clone https://github.com/beetbox/beets.git``.
2. Then enter the beets directory ``cd beets``
3. Finally install ``python setup.py install``.
- **Option 3** - Use ``pip`` to install an "editable" version of beets based on an
automatic source checkout. For example, run:
- **Use ``pip`` to install an "editable" version of beets based on an
automatic source checkout.**
For example, run:
``pip install -e git+https://github.com/beetbox/beets#egg=beets``
to clone beets and install it, allowing you to modify the source
in-place to try out changes.