owen/lms
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updated documentation

Browse Source
This commit is contained in:
emeric
2018-06-02 20:03:36 +02:00
parent fff899cecb
commit 96dd5d48ce
2 changed files with 12 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+5 -3
View File
@@ -5,9 +5,11 @@ It allows you to access your music using an http(s) web interface.
## Features ## Features
- Audio transcode for maximum interoperability and low bandwith requirements - Audio transcode for maximum interoperability and low bandwith requirements
- MusicBrainzID support to handle duplicated artist and release names
- Filter by genre and/or group
- User management - User management
- Browse your audio collection using tag-based filters
- Custom tags scan
- MusicBrainzID support to handle duplicated artist and release names
- Reverse proxy support
LMS is written entirely in C++. Therefore, it is suitable to run on embedded devices, where space and memory are limited. LMS is written entirely in C++. Therefore, it is suitable to run on embedded devices, where space and memory are limited.
@@ -28,7 +30,7 @@ mkdir build
cd build cd build
../configure --prefix=/usr --sysconfdir=/etc ../configure --prefix=/usr --sysconfdir=/etc
``` ```
configure will complain if a mandatory library is missing. configure will report any missing library.
```sh ```sh
make make
TODO
+7 -13
View File
@@ -7,11 +7,9 @@
- Implement a cache to improve speed - Implement a cache to improve speed
[Database] [Database]
- Optim, use SQL query to get the "genre" orphans
- Use Inotify like system to watch modified/added files? - Use Inotify like system to watch modified/added files?
- handle access rights problems (instead of aborting) - handle access rights problems (instead of aborting)
- add a global play counter for tracks. This will help people to spot most popular files - add a global play counter for tracks. This will help people to spot most popular files
- Make cluster scan configurable as it is very difficult to handle them all?
- Use albumartist when available (useful for compilations) - Use albumartist when available (useful for compilations)
- Add AcousticBrainz support to create new kind of clusters - Add AcousticBrainz support to create new kind of clusters
@@ -19,27 +17,23 @@
- WMA covers: add support - WMA covers: add support
[Playlist] [Playlist]
- Save/Load playlists
- Make public playlists so that users can see what other people are listening to - Make public playlists so that users can see what other people are listening to
[Users] [Users]
- Handle login lifetime? - Handle login lifetime?
- Use the WServer::post method to kick users already logged in? - Use the WServer::post method to kick users already logged in?
- Or save the current playqueue by session (using a cookie)?
- Limit multi login from UI and API interfaces (limit per interface is acceptable) - Limit multi login from UI and API interfaces (limit per interface is acceptable)
[UI] [UI]
- Add a download button to get the current playqueue in a streamed zip file - Add a download button to get the current playqueue in a streamed zip file
- Save user prefs in local storage (volume, loop, shuffle, current playqueue, etc.) - Save user prefs in local storage (volume, loop, shuffle, current playqueue, etc.)
- Add keyboard shortcuts - Add keyboard shortcuts
- Add a hint for the user to get the nature of tag (created from genre ? created from audio features?) - Implement a decent player
- Implement a play queue
- Implement a decent player
- Dedicate a color for each tag type
- Display only the most popular cluster of each cluster type?
[Settings] [Settings]
- Add a user management view - Add multi root directories support
- Add multi root directories support
- Add a first connection wizard
[REST API] [REST API]
- Make a dedicated REST API. Maybe use the SubSonic API or Ampache API? - Make a dedicated REST API. Maybe use the SubSonic API or Ampache API?