From 45353fbc7d46e51f157a9ae81ec15aba2f6b4f16 Mon Sep 17 00:00:00 2001
From: Antoine WEBER <a.weber@sdv.fr>
Date: Tue, 22 Sep 2015 16:38:20 +0200
Subject: [PATCH] modification du readme

---
 README.md | 81 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 81 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a637a29
--- /dev/null
+++ b/README.md
@@ -0,0 +1,81 @@
+Plex Web Downloader
+===============
+
+Ce projet permet de créer une liste de vos fichiers vidéo plex et de les partager aux travers d'une interface web.
+
+
+INSTALLATION
+--------------------
+
+**Sur Windows**
+  pré requis, installer git ( https://git-scm.com/download/win )
+  pré requis, installer nodejs 0.12.x ( https://nodejs.org/dist/v0.12.7/ )
+  ouvrir l'invite de commande 'cmb', puis se deplacer dans un repertoire où vous voulez installer
+  taper: git clone https://github.com/TwanoO67/plex-web-downloader.git
+  taper: cd plex-web-downloader
+  taper: npm install
+  modifier le fichier config.js, pour le chemin de database (attention il faut doubler les \ et proteger les espaces )
+    exemple: C:\\Users\\yourUsername\\AppData\\Local\\Plex\ Media\ Server\\Plug-in\ Support\\Databases\\com.plexapp.plugins.library.db
+  taper: npm start
+  puis ouvrir http://localhost:3000
+
+**Sous MacOS**
+  pré requis, nodejs
+    sinon installer homebrew ( ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)" )
+    puis brew install node
+  git clone https://github.com/TwanoO67/plex-web-downloader.git
+  cd plex-web-downloader
+  npm install
+  modifier le fichier config.js, pour le chemin de database
+    exemple: /Users/yourUsername/Library/Application Support/Plex Media Server/Plug-in Support/Databases/com.plexapp.plugins.library.db
+  npm start
+  puis ouvrir http://localhost:3000
+
+**Sous Ubuntu**
+  pré requis nodejs, ou apt-get install nodejs
+  ln -s /usr/bin/nodejs /usr/local/bin/node
+  git clone https://github.com/TwanoO67/plex-web-downloader.git
+  cd plex-web-downloader
+  npm install
+  modifier le fichier config.js, pour le chemin de database
+    exemple: /home/yourUsername/plex-config/Plex Media Server/Plug-in Support/Databases/com.plexapp.plugins.library.db
+  npm start
+  puis ouvrir http://localhost:3000
+
+
+DEVELOPPEMENT
+--------------------
+
+//le projet a été créée initialement avec
+node install express -g
+node install express-generator -g
+express nom_du_projet
+cd nom_du_projet
+npm install
+
+//pour installer plex (depuis un dockerfile)
+mkdir ~/plex-config
+sudo chown 797:797 -R ~/plex-config
+sudo docker run -d --restart=always -v ~/plex-config:/config -v ~/Movies:/media/plex -p 32400:32400 wernight/plex-media-server
+sudo chmod 777 ~/plex-config/Plex\ Media\ Server/Plug-in\ Support/Databases/*
+sudo chmod 777 ~/Movies
+sudo ln -s ~/Movies /media/plex
+configurer vos chaines sur: http://localhost:32400/web/index.html
+
+
+COMPILATION
+--------------------
+
+npm install enclose -g
+enclose -o bin/mac_bin --loglevel info -c enclose_config.js -v 0.12.7 ./bin/www
+
+
+TODO Liste
+--------------------
+* Ajouter une présentation sur l'index, configurable dans config.js
+* Gérer les images des vignettes
+* Faire une page spéciales pour les séries
+* Gérer les téléchargements multi-source en proposant un lien aria2 (voir aria2.sourceforge.net)
+* Intégré web ui: http://ziahamza.github.io/webui-aria2/
+* Clusterisé avec un fork par cpu
+* Mettre en place une limite d'upload activable à la demande