Skip to content

Commit

Permalink
Add more detailed installation document
Browse files Browse the repository at this point in the history
  • Loading branch information
malept committed Mar 11, 2014
1 parent 6f9ecef commit 1fbc70b
Show file tree
Hide file tree
Showing 2 changed files with 47 additions and 2 deletions.
44 changes: 44 additions & 0 deletions INSTALL.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
===============================
Installing ``gmusicprocurator``
===============================

Requirements
------------

Backend
~~~~~~~

* Python 2.7 (only tested with CPython)
* virtualenv (optional, but recommended)

Frontend
~~~~~~~~

* Sass_
* Node.js + NPM
* Bower (``npm install bower``)
* CoffeeScript (``npm install -g coffee-script``)
* UglifyJS2 (``npm install -g uglify-js``)
* importer (``npm install -g importer``)


.. _Sass: http://sass-lang.com/

Instructions
------------

These instructions are similar to the quick installation in ``README.rst``.
This is meant as a supplement, so that the HTML5 frontend is installed
correctly.

.. code-block:: console
$ git clone --recursive https://github.com/malept/gmusicprocurator.git
$ cd gmusicprocurator
$ bower install -p # Added for frontend installation
$ virtualenv venv # Added for creating a separate virtualenv
$ source venv/bin/activate
(venv) $ pip install -r requirements.txt
(venv) $ python -m gmusicprocurator list_devices --no-desktop
# See quick install in README.rst
(venv) $ python -m gmusicprocurator runserver
5 changes: 3 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,8 @@ Quick Install

This has only been tested on Python 2.7.

These instructions are for running the proxy only.
These instructions are for running the proxy only. For proxy + frontend
instructions, consult ``INSTALL.rst``.

Create a config file in ``~/.config/gmusicapi/gmusicprocurator.cfg`` that looks like
this:
Expand All @@ -39,7 +40,7 @@ Then run the following:

.. code-block:: console
$ git clone git://github.com/malept/gmusicprocurator.git
$ git clone https://github.com/malept/gmusicprocurator.git
$ cd gmusicprocurator
$ pip install -r requirements.txt
$ python -m gmusicprocurator list_devices --no-desktop
Expand Down

0 comments on commit 1fbc70b

Please sign in to comment.