From 950dbe3b9f5a3a4c5ff6689c6312e1862d93cada Mon Sep 17 00:00:00 2001 From: "Kyle R. Conway" Date: Fri, 23 Oct 2020 00:41:58 -0500 Subject: [PATCH 1/2] Update faq.rst MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit A couple of suggested modifications primarily to clarify that this unordered list is of **options** to install the latest version―not a series of commands to complete a single install. Also suggested a layout change to explain the series of commands in option b. --- docs/faq.rst | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) diff --git a/docs/faq.rst b/docs/faq.rst index eeab6c1ef..8af404fce 100644 --- a/docs/faq.rst +++ b/docs/faq.rst @@ -137,13 +137,16 @@ it's helpful to run on the "bleeding edge". To run the latest source: ``pip uninstall beets``. 2. Install from source. There are a few easy ways to do this: - - Use ``pip`` to install the latest snapshot tarball: just type - ``pip install https://github.com/beetbox/beets/tarball/master``. - - Grab the source using Git: - ``git clone https://github.com/beetbox/beets.git``. Then - ``cd beets`` and type ``python setup.py install``. - - Use ``pip`` to install an "editable" version of beets based on an - automatic source checkout. For example, run + - **Option 1** - 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: + + 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: ``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. From d0cbf098c60ca27f3e75cf899026979f19dcca00 Mon Sep 17 00:00:00 2001 From: "Kyle R. Conway" Date: Fri, 23 Oct 2020 11:06:16 -0500 Subject: [PATCH 2/2] 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! --- docs/faq.rst | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/docs/faq.rst b/docs/faq.rst index 8af404fce..deecfabcf 100644 --- a/docs/faq.rst +++ b/docs/faq.rst @@ -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.