third-party-mirrors/navidrome
1
0
Fork 0
mirror of https://github.com/navidrome/navidrome.git synced 2025-06-09 20:02:22 +03:00
Code Issues Packages Projects Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
Deluan 2020-01-04 21:16:10 -05:00
parent 0fe523b526
commit 2df05288d3
1 changed files with 19 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@ -1,25 +1,23 @@
CloudSonic Server # CloudSonic Server
=======
[![Build Status](https://travis-ci.org/cloudsonic/sonic-server.svg?branch=master)](https://travis-ci.org/cloudsonic/sonic-server) [![Build Status](https://travis-ci.org/cloudsonic/sonic-server.svg?branch=master)](https://travis-ci.org/cloudsonic/sonic-server)
[![Go Report Card](https://goreportcard.com/badge/github.com/cloudsonic/sonic-server)](https://goreportcard.com/report/github.com/cloudsonic/sonic-server) [![Go Report Card](https://goreportcard.com/badge/github.com/cloudsonic/sonic-server)](https://goreportcard.com/report/github.com/cloudsonic/sonic-server)
__This is still a work in progress, and has no releases available__ **This is still a work in progress, and has no releases available**
CloudSonic is a music collection server and streamer, optmized to run on cheap VPS servers. It implements the CloudSonic is a music collection server and streamer, optmized to run on cheap VPS servers. It implements the
[Subsonic](http://www.subsonic.org) API [Subsonic](http://www.subsonic.org) API
The project's main goals are: The project's main goals are:
* Be fully compatible with available [Subsonic clients](http://www.subsonic.org/pages/apps.jsp) - Be fully compatible with available [Subsonic clients](http://www.subsonic.org/pages/apps.jsp)
(actively being tested with (actively being tested with
[DSub](http://www.subsonic.org/pages/apps.jsp#dsub), [DSub](http://www.subsonic.org/pages/apps.jsp#dsub),
[SubFire](http://www.subsonic.org/pages/apps.jsp#subfire) and [SubFire](http://www.subsonic.org/pages/apps.jsp#subfire) and
[Jamstash](http://www.subsonic.org/pages/apps.jsp#jamstash)) [Jamstash](http://www.subsonic.org/pages/apps.jsp#jamstash))
* Import and use all metadata from iTunes, so that you can optionally keep using iTunes to manage your music - Import and use all metadata from iTunes, so that you can optionally keep using iTunes to manage your music
* Implement Smart Playlists, as iTunes - Implement Smart Playlists, as iTunes
* Help me learn Go ;) [![Gopher](https://blog.golang.org/favicon.ico)](https://golang.org) - Help me learn Go ;) [![Gopher](https://blog.golang.org/favicon.ico)](https://golang.org)
### Supported Subsonic API version ### Supported Subsonic API version
@ -31,17 +29,20 @@ Check the (almost) up to date [compatibility chart](https://github.com/cloudsoni
As this is a work in progress, there are no installers yet. To have the server running in your computer, follow the steps in the As this is a work in progress, there are no installers yet. To have the server running in your computer, follow the steps in the
Development Environment section below, then run it with: Development Environment section below, then run it with:
``` ```
$ export SONIC_MUSICFOLDER="/path/to/your/iTunes Library.xml" $ export SONIC_MUSICFOLDER="/path/to/your/iTunes Library.xml"
$ bee run $ make run
``` ```
The server should start listening on port 4533. The server should start listening on port 4533.
### Development Environment ### Development Environment
You will need to install [Go 1.8](https://golang.org/dl/) You will need to install [Go 1.13](https://golang.org/dl/)
Then install dependencies: Then install dependencies:
``` ```
$ make setup $ make setup
``` ```
@ -56,9 +57,8 @@ $ make run
$ make test $ make test
``` ```
### Copying ### Copying
CloudSonic - Copyright (C) 2017 Deluan Cotts Quintao CloudSonic - Copyright (C) 2017-2020 Deluan Cotts Quintao
The source code is licensed under GNU Affero GPL v3. License is available [here](/LICENSE) The source code is licensed under GNU Affero GPL v3. License is available [here](/LICENSE)