From: Kristoffer Grönlund Date: Sun, 3 Jan 2010 11:56:44 +0000 (+0100) Subject: Renamed README to README.md for githubs sake X-Git-Url: https://vcs.maemo.org/git/?p=jamaendo;a=commitdiff_plain;h=53d91b1e9c48ee34817c5a85f85b7d7f12a1c400 Renamed README to README.md for githubs sake --- diff --git a/README b/README deleted file mode 100644 index ec9365f..0000000 --- a/README +++ /dev/null @@ -1,44 +0,0 @@ -# Jamaendo - -A media player for the Nokia N900 and other Maemo 5 (Fremantle) phones. - -[Jamaendo][jamaendo] plays music from the music catalog of [JAMENDO][jamendo]. - -JAMENDO is an online platform that distributes musical works under -Creative Commons licenses. - -Jamaendo is written by Kristoffer Grönlund. - -## Panucci - -[Jamaendo][jamaendo] is based on [Panucci][panucci], an audiobook and podcast player for -Maemo. Panucci is written by - - [jamendo]: http://www.jamendo.com/ "Jamendo" - [jamaendo]: http://jamaendo.garage.maemo.org/ "Jamaendo" - [panucci]: http://panucci.garage.maemo.org/ "Panucci" - -## Installation - -To build the packages, you need a scratchbox environment set up. See -the Nokia/Maemo documentation for information on how to do this. To -build the package, go to the Jamaendo source directory and type - - make build-package - -This will (hopefully) generate a .deb file for you to install on your -Maemo 5 device. - -## Optification - -If you're running a newer release of the Fremantle platform, this step -may not (I hope not!) be necessary, but either way: The package that -the build process produces is not entirely optified. It is compatible -with the `maemo-optify` tool, however. All you need to do is run -`maemo-optify-deb` on the generated .deb file. - -## License - -The backend code that speaks to jamendo.com is in the jamaendo module. This module is licensed under a modified New BSD License (modified to remove attribution clauses). See `jamaendo/api.py` for details. - -The code that implements the UI and the rest of the application is licensed under a GPL v3 license. diff --git a/README.md b/README.md new file mode 100644 index 0000000..ec9365f --- /dev/null +++ b/README.md @@ -0,0 +1,44 @@ +# Jamaendo + +A media player for the Nokia N900 and other Maemo 5 (Fremantle) phones. + +[Jamaendo][jamaendo] plays music from the music catalog of [JAMENDO][jamendo]. + +JAMENDO is an online platform that distributes musical works under +Creative Commons licenses. + +Jamaendo is written by Kristoffer Grönlund. + +## Panucci + +[Jamaendo][jamaendo] is based on [Panucci][panucci], an audiobook and podcast player for +Maemo. Panucci is written by + + [jamendo]: http://www.jamendo.com/ "Jamendo" + [jamaendo]: http://jamaendo.garage.maemo.org/ "Jamaendo" + [panucci]: http://panucci.garage.maemo.org/ "Panucci" + +## Installation + +To build the packages, you need a scratchbox environment set up. See +the Nokia/Maemo documentation for information on how to do this. To +build the package, go to the Jamaendo source directory and type + + make build-package + +This will (hopefully) generate a .deb file for you to install on your +Maemo 5 device. + +## Optification + +If you're running a newer release of the Fremantle platform, this step +may not (I hope not!) be necessary, but either way: The package that +the build process produces is not entirely optified. It is compatible +with the `maemo-optify` tool, however. All you need to do is run +`maemo-optify-deb` on the generated .deb file. + +## License + +The backend code that speaks to jamendo.com is in the jamaendo module. This module is licensed under a modified New BSD License (modified to remove attribution clauses). See `jamaendo/api.py` for details. + +The code that implements the UI and the rest of the application is licensed under a GPL v3 license.