X-Git-Url: https://git.auder.net/?p=mixstore.git;a=blobdiff_plain;f=README.md;fp=README.md;h=f393838f96306c10cab1c7ec59a6a607b823f708;hp=0000000000000000000000000000000000000000;hb=59b78c2aa14412f45f232496d807e6b221cf991a;hpb=4033e4e437566b9ff9301e9166ef90fc03a7db6f

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f393838
--- /dev/null
+++ b/README.md
@@ -0,0 +1,20 @@
+# [mixstore](https://auder.net/mixstore)
+
+Website which gather packages using mixture models, for any purpose like</span>
+* Density estimation;
+* Classification, supervised or not;
+* Regression, ...>
+
+Packages can be written in any language (please contact me if your favorite language is missing).
+
+mixstore is powered by Symfony2. See [the architecture tour](http://symfony.com/doc/current/quick_tour/the_architecture.html) to understand folders structure.
+
+## Usage
+
+As a visitor you can browse the store (main button on top of the screen), and sort packages by name or language.
+
+As a registered user (follow the link in upper-right corner):
+1. you can give feedback on any published package (through the button "new feedback" on every package page);
+2. you can publish pages for new packages, whether you are the author or not.
+
+A banner image can be uploaded when sending a new package. This image will be included in the carousel on welcome page.