[DOC] Updated README

This commit is contained in:
emeric
2016-06-05 14:27:34 +02:00
parent 7c475ee2d3
commit 85a61e46ee
+9 -5
View File
@@ -1,17 +1,21 @@
# LMS - Lightweight Media Server # LMS - Lightweight Media Server
LMS is a self-hosted media streaming software, released under the GPLv3 license. LMS is a self-hosted media streaming software, released under the GPLv3 license.
It allows you to access your music and your videos using an https web interface. It allows you to access your music and your videos using an http(s) web interface.
## Features ## Features
- Winamp-like interface, suited for large media collections - Winamp-like interface, suited for large media collections
- Audio/Video transcode for maximum interoperability and low bandwith requirements - Audio/Video transcode for maximum interoperability and low bandwith requirements
- User management - User management
- Multi genre - Playlist support
- MusicBrainzID support - MusicBrainzID support to handle duplicated artist and release names
Tags are automatically created to facilitate music searching, using:
- Multi genre information from metadata
- High-level information from AcousticBrainz
Please note LMS is still under development and will gain more features in the future: Please note LMS is still under development and will gain more features in the future:
- Radio function (using AcousticBrainz) - Radio function
- Interface suited for mobile devices - Interface suited for mobile devices
- Video support - Video support
- Subsonic and/or Ampache API - Subsonic and/or Ampache API
@@ -58,7 +62,7 @@ By default, LMS will read its configuration in the file '/etc/lms.conf'
## Running ## Running
```sh ```sh
$ /usr/bin/lms [/path/to/config/file] $ /usr/bin/lms [config_file]
``` ```
LMS needs write access to the directory used for the database. LMS needs write access to the directory used for the database.
It is highly recommended to run LMS as a non root user. It is highly recommended to run LMS as a non root user.