gandazgul / mandolin Goto Github PK

Thank you for downloading Mandolin.

INSTALL

Mandolin is a web application, to use it you need a web server. You will also need PHP 5.2 or later.
Copy the files you just downloaded to your webserver root directory and follow the steps below.

1 - Rename the install folder from 'install--' to 'install'
2 - Delete the data/mandolin.db file if is there as it contains dummy data used during development.
3 - Set the appropiate permissions for your files on the server. IMPORTANT: the data/ folder and the settings.json file within need to be writable by the user where the webserver runs (for apache is usually www-data)
4 - Browse to the aplication and the install script will start, follow the screens to configure the system.
5 - After the install is complete you have to delete the 'install' folder and follow the last instructions from the install page.
6 - Add your music library folder in the admin page and you should be all set to use Mandolin.

If you have any questions, suggestions, critiques or if you want to help leave me a message in github.

MODIFYING THE CODE

Mandolin is licensed under the GPL v2.
There is a HACKING file that you should read to understand how the code is setup and what is the logic behind it.
There is also a TODO file with known problems and things I have planned to do in the near future.

Enjoy!