commit c9d5da3b2c48c071031a37882ad9a5e29edae98a Author: Óscar García Amor Date: Fri Jul 8 12:40:44 2022 +0200 Initial commit diff --git a/README.md b/README.md new file mode 100644 index 00000000..26d59859 --- /dev/null +++ b/README.md @@ -0,0 +1,82 @@ +# WE HAVE MOVED + +Ultrasonic code is now hosted in [GitLab][ultrasonic]. + +- New Web: https://ultrasonic.gitlab.io +- New Git: https://gitlab.com/ultrasonic/ultrasonic +- New bugtracker: https://gitlab.com/ultrasonic/ultrasonic/-/issues +- New releases: https://gitlab.com/ultrasonic/ultrasonic/-/issues + +[ultrasonic]: https://gitlab.com/ultrasonic/ultrasonic + +# Ultrasonic + +Ultrasonic is free and open-source music streaming Android client for +[Subsonic][subsonic] [API][subapi] (version 1.7.0 or higher) compatible +servers. + +## Help wanted + +We currently don't have that much time to spend developing Subsonic, so any +contributions or active developers are always welcomed. +Have a look at [CONTRIBUTING](CONTRIBUTING.md) to get started. + +## Download + +App is available to download at following stores: + +[Get it on Google Play](https://play.google.com/store/apps/details?id=org.moire.ultrasonic) +[Get it on F-Droid](https://f-droid.org/packages/org.moire.ultrasonic/) +[Get it on GitLab](https://gitlab.com/ultrasonic/ultrasonic/-/releases) + +**Warning**: All three versions (Google Play, F-Droid and the APKs) are not +compatible (not signed by the same key)! You must uninstall one to install +the other, which will delete all your data. + +If you want to use the version downloaded from F-Droid or from GitLab with +**Android Auto**, you must enable Unknown Sources as it is described in +[this wiki page][wikiaa]. + +## Bugs and issues + +First, see if your issue haven’t been yet reported [here][issues], otherwise +open [a new issue][newissue]. + +### Known (not our) bugs + +If you are using *Madsonic 5.1.X* several sections of Ultrasonic will not +work. This is caused by bad implementation of Subsonic API by Madsonic. For +more info about this you can read [this bug][madbug]. + +## Contributing + +See [CONTRIBUTING](CONTRIBUTING.md). + +## Supported (tested) Subsonic API implementations + +- [Subsonic][subsonic] +- [Airsonic-Advanced][airsonic] +- [Supysonic][supysonic] +- [Ampache][ampache] + +Other *Subsonic API* implementations should work as well as long as they +follow API [documentation][subapi]. + +## License + +This software is licensed under the terms of the GNU General Public License +version 3 (GPLv3). + +Full text of the license is available in the [LICENSE](LICENSE) file and +[online][gpl3]. + +[wikiaa]: https://gitlab.com/ultrasonic/ultrasonic/-/wikis/Using-Ultrasonic-with-Android-Auto +[issues]: https://gitlab.com/ultrasonic/ultrasonic/-/issues +[newissue]: https://gitlab.com/ultrasonic/ultrasonic/-/issues/new +[madbug]: https://gitlab.com/ultrasonic/ultrasonic/-/issues/129 +[subsonic]: http://www.subsonic.org/ +[subapi]: http://www.subsonic.org/pages/api.jsp +[airsonic]: https://github.com/airsonic-advanced/airsonic-advanced +[supysonic]: https://github.com/spl0k/supysonic +[ampache]: https://ampache.org/ +[gpl3]: https://opensource.org/licenses/gpl-3.0.html