From 20be9a4f04569f7e4f533436f34b99e100870944 Mon Sep 17 00:00:00 2001
From: Edouard DUPIN <yui.heero@gmail.com>
Date: Sun, 19 Jun 2022 19:23:24 +0200
Subject: [PATCH] [DEV] initial commit

---
 readme.md | 46 ++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 46 insertions(+)
 create mode 100644 readme.md

diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..ea86d2e
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,46 @@
+Karideo
+=======
+
+**K**angaroo **A**nd **R**abbit (m)usic is a simple framework to propose music streaming for personal network
+
+Run and install:
+================
+
+so simple...
+
+```{.bash}
+# start the Bdd interface (no big data > 50Mo)
+cd bdd
+docker-compose up -d
+# start the REST API
+cd back
+docker-compose up -d
+# start the front API
+cd ../front
+docker-compose up -d
+```
+
+TODO list:
+==========
+
+  - API to add cover (media && group)
+  - GUI to add cover (media && group)
+  - GUI to add a media
+  - GUI to check if media already uploaded
+  - GUI to play the next episode
+  - GUI to do back on the view
+  - GUI corect the reload webPage
+  - API for univers
+  - GUI to change the name of a media
+  - GUI to change the group of the media
+  - GUI to change the saison of the media
+  - GUI to change the episode number of the media
+  - GUI to change the univers of the media
+  - GUI to add new univers, group, saison
+  - Application mode of the GUI
+  - Correct the problem of production mode
+  - API add OAuth model
+  - API add user specific last view and position in videos and series
+  - ...
+  
+