Skip to content
This repository has been archived by the owner on Feb 9, 2024. It is now read-only.

Commit

Permalink
Sekelton docs in place.
Browse files Browse the repository at this point in the history
  • Loading branch information
mayhem committed Jan 31, 2024
1 parent bb51e81 commit f95c1cc
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 31 deletions.
8 changes: 6 additions & 2 deletions docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,12 @@ Installation
Installation for End Users
--------------------------

Run pip, yo!
For end users, install from pip with:

.. code-block:: bash
pip3 install lb_content_resolver
Installation for Development
----------------------------
Expand Down Expand Up @@ -34,4 +39,3 @@ Use these commands to install on Windows:
.ve\Scripts\activate.bat
pip install .[tests]
python -m troi.cli --help
30 changes: 1 addition & 29 deletions docs/user-guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,32 +7,4 @@ Update for content resolver.

.. code-block:: bash
python -m troi.cli
To list all the patches that are currently available, do:

.. code-block:: bash
python -m troi.cli list
To generate a playlist from a patch and display it in the terminal, do:

.. code-block:: bash
python -m troi.cli playlist --print daily-jams <user_name>
This will generate a playlist and print the list to the terminal.


To generate a playlist from a patch and display it and then upload it to ListenBrainz:

.. code-block:: bash
python -m troi.cli playlist --print --upload --token <user-token> daily-jams <user_name>
This will generate a playlist and print the list to the terminal and then upload it to ListenBrainz. You can find your
user token on your `profile page at ListenBrainz <https://listenbrainz.org/profile/>`_.

From here on you can explore different :ref:`patches` or read how Troi works :ref:`technical-introduction`
resolve create

0 comments on commit f95c1cc

Please sign in to comment.