Browse Source

README and LICENSE updated

master
Phyks 9 years ago
parent
commit
0e4dcd9952
  1. 21
      LICENSE
  2. 13
      README.md
  3. 3
      TODO

21
LICENSE

@ -2,19 +2,16 @@ This program uses several libraries and external services. @@ -2,19 +2,16 @@ This program uses several libraries and external services.
The main license for this program is (everything but below) :
=========================================================================================
This software (Velib) is licensed under the zlib/libpng License.
Copyright (c) 2013 Phyks
This software is provided 'as-is', without any express or implied warranty. In no event will the authors be held liable for any damages arising from the use of this software.
Permission is granted to anyone to use this software for any purpose, including commercial applications, and to alter it and redistribute it freely, subject to the following restrictions:
1. The origin of this software must not be misrepresented; you must not claim that you wrote the original software. If you use this software in a product, an acknowledgment in the product documentation would be appreciated but is not required.
2. Altered source versions must be plainly marked as such, and must not be misrepresented as being the original software.
3. This notice may not be removed or altered from any source distribution.
* --------------------------------------------------------------------------------
* "THE NO-ALCOHOL BEER-WARE LICENSE" (Revision 42):
* Phyks (webmaster@phyks.me) wrote this file. As long as you retain this notice you
* can do whatever you want with this stuff (and you can also do whatever you want
* with this stuff without retaining it, but that's not cool...). If we meet some
* day, and you think this stuff is worth it, you can buy me a <del>beer</del> soda
* in return.
* Phyks
* ---------------------------------------------------------------------------------
==========================================================================================
==========================================================================================

13
README.md

@ -1,5 +1,5 @@ @@ -1,5 +1,5 @@
README for Velib app
====================================================================================
====================
(An english version is available below)
Cette application a été developpée par Phyks (webmaster@phyks.me). Elle vous permet de localiser les vélibs et les emplacements de vélibs les plus proches de vous et de vous y guider. Elle est distribuée sous licence zlib/libpng.
@ -18,9 +18,9 @@ Installation sur votre serveur : @@ -18,9 +18,9 @@ Installation sur votre serveur :
* L'application mettra automatiquement à jour la liste des stations au premier démarrage.
* Pour mettre à jour automatiquement la liste des stations, vous pouvez utiliser une tâche cron comme suit :
sudo crontab -e
<code>sudo crontab -e</code>
puis insérer la ligne
* * * * * wget -q -O adresse_de_base_de_velib/index.php?update=1&code=code_synchro #Commande de mise a jour des stations de velib
<code>* * * * * wget -q -O adresse_de_base_de_velib/index.php?update=1&code=code_synchro #Commande de mise a jour des stations de velib</code>
en remplaçant code_synchro par votre code de synchronisation et en définissant * conformément à la fréquence de mises à jour souhaitée.
@ -29,7 +29,6 @@ Notes : @@ -29,7 +29,6 @@ Notes :
* Si vous avez perdu votre code de synchronisation, il suffit de supprimer le fichier data/data pour le réinitialiser (il faudra alors refaire une synchronisation des stations à la visite suivante).
* Bien que cette application ait été optimisée, notamment au niveau du nombre de requêtes vers des services distants, elle a été créée dans l'optique de répondre à mon besoin et peut supporter difficilement une charge importante.
====================================================================================
====================================================================================
====================================================================================
English version :
@ -43,16 +42,16 @@ The reverse geolocation system is provided by Mapquest, maps are provided by Ope @@ -43,16 +42,16 @@ The reverse geolocation system is provided by Mapquest, maps are provided by Ope
For any suggestion or remark, please send me an e-mail at webmaster@phyks.me.
Installation on your own server :
================================
=================================
* Decompress the archive file in a folder accessible to your web server.
* Ensure that your web server can write in the "data" directory.
* Edit the configuration in the js.js file (OSM tiles provider, reverse geolocation provider and email).
* The application will automatically update the stations list at first run.
* To automatically update the stations list, you can use a cron task as following :
sudo crontab -e
<code>sudo crontab -e</code>
then, add a line
* * * * * wget -q -O adresse_de_base_de_velib/index.php?update=1&code=code_synchro #Update velib stations
<code>* * * * * wget -q -O adresse_de_base_de_velib/index.php?update=1&code=code_synchro #Update velib stations</code>
Don't forget to replace code_synchro by your synchronisation code and define * according to the update frequency you want.

3
TODO

@ -0,0 +1,3 @@ @@ -0,0 +1,3 @@
Update README.md
Update LICENSE
Recherche de Velib autour d'une adresse (pas besoin de positionnement satellite)
Loading…
Cancel
Save