README.html

[mixstore.git] / README.html

diff --git a/README.html b/README.html
new file mode 100644 (file)
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>