Skip to content

Commit

Permalink
📚 Update package documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
tterb committed Oct 30, 2018
1 parent 49bf916 commit 4938dff
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 33 deletions.
36 changes: 33 additions & 3 deletions docs/getting_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,25 @@ Getting Started
:width: 600
:alt: Terminal


Install
^^^^^^^^^

You can install the program with the following command:

.. code:: bash
$ pip install yt2mp3
Prerequisites
--------------
-------------

The program only requires that you have Python 3.4+ and `ffmpeg <https://www.ffmpeg.org/>`_ or `libav <https://www.libav.org/>`_ installed. More installation information is available on the `additional setup <http://yt2mp3.rtfd.io>`_ page.

----------------------

Usage
-------
^^^^^^^

Once installed, the program can be executed via the command-line as follows:

Expand All @@ -24,7 +36,7 @@ Once installed, the program can be executed via the command-line as follows:
When the program is finished, you can find the resulting MP3 file in your *Downloads* directory, with the following file-structure ``Music/{artist}/{track}.mp3``.

Options
^^^^^^^^
--------

.. list-table::
:widths: 25 75
Expand Down Expand Up @@ -55,4 +67,22 @@ Options
* - ``-h, --help``
- Display information on usage and functionality

-----------------

Contributing
^^^^^^^^^^^^^

If you'd like to contribute to the project, you can download and install the program with the following commands:

.. code:: bash
# Clone the repository
$ git clone https://github.com/tterb/yt2mp3
# Navigate to the directory
$ cd yt2mp3
# Install program dependencies
$ pip install -r requirements.txt
|
30 changes: 0 additions & 30 deletions docs/install.rst

This file was deleted.

0 comments on commit 4938dff

Please sign in to comment.