initial commit

readme.md

@@ -0,0 +1,41 @@
+# Audio diffusion web manager
+
+A program that provides a way to diffuse audio over multiple devices on a local network.
+
+## Usage
+
+1. Download the executable corresponding to your OS (Windows / Linux / Mac) here.
+2. Run the program and take note of the given web address.
+3. Open this address in a browser (Firefox / Chrome / ...).
+4. Use the interface to upload files, create device groups, assignate devices to groups, start diffusion, ...
+
+## Project status
+
+This project was done as a way to relearn how to use some tools / libraries / ...
+
+As such, there is no garanty that it will be maintained and / or improved (despite the current lack of basic features - such as playlists).
+
+That is, if you found a bug, need a feature or have an improvement idea, feel free to send it to open a ticket.
+
+### Known bug
+
+#### Audio is out of sync
+
+Currently only the device clock is used for audio synchronisation.
+If a device clock is even slightly wrong, the audio will be as well.
+
+Forcing the update of the device clock may solve the issue, but a better way would be to implement a delay detection as well as a way to manually set a device delay.
+
+### Possible improvements
+
+- Queuing more than one audio file
+- Setting device playback volume
+- Setting device delay manually
+- Detecting device delay automatically
+- Description of device connexion state (not connected / active / timeout)
+- Uploading file by drag and drop
+- Uploading many files at once
+
+## License
+
+TODO