From: Benjamin Auder <benjamin.a@mailoo.org>
Date: Thu, 5 Feb 2015 19:28:53 +0000 (+0100)
Subject: README.html
X-Git-Url: https://git.auder.net/%7B%7B%20asset%28%27mixstore/images/assets/current/doc/index.css?a=commitdiff_plain;h=85079bfa1f0b279c37d2b1e6d49908217c8182c7;p=mixstore.git

README.html
---

diff --git a/README b/README
deleted file mode 100644
index 2fb75fa..0000000
--- a/README
+++ /dev/null
@@ -1,12 +0,0 @@
-mixstore utilise Symfony2 ; organisation des répertoires :
-
-    app/: La configuration de l'application,
-    src/: Le code PHP du projet,
-    vendor/: Les bibliothèques tierces,
-    web/: Le répertoire Web racine.
-
-Le répertoire web racine est l'endroit ou se situent tous les fichiers statiques 
-et publics comme les images, les feuilles de styles et les fichiers javascript.
-C'est aussi le dossier contenant le point d'entrée web/app.php
-
-[Voir http://symfony.com/fr/doc/current/quick_tour/the_architecture.html]
diff --git a/README.html b/README.html
new file mode 100644
index 0000000..7e580b4
--- /dev/null
+++ b/README.html
@@ -0,0 +1,25 @@
+<h1>mixstore.org</h1>
+
+<span>Website which gather packages using mixture models, for any purpose like</span>
+<ul>
+	<li>Density estimation;</li>
+	<li>Classification, supervised or not;</li>
+	<li>Regression, ...</li>
+</ul>
+
+<p>The packages can be written in any language (please contact me if your favorite is missing from the list).</p>
+
+<p>mixstore.org is powered by Symfony2. See <a href="http://symfony.com/fr/doc/current/quick_tour/the_architecture.html">this page</a> 
+to understand folders structure.</p>
+
+<h2>Usage</h2>
+
+<p>As a visitor you can browse the store (main button on top of the screen), and sort packages by name or language.</p>
+
+<span>As a registered user (follow the link in upper-right corner):</span>
+<ol>
+	<li>you can give feedback on any published package (through the button "new feedback" on every package page);</li>
+	<li>you can publish pages for new packages, whether you are the author or not.</li>
+</ol>
+
+<p>A banner image can be uploaded when sending a new package. This image will be included in the carousel on welcome page.</p>