Move the website and the documentation do MkDocs

CONTRIBUTING.md

@@ -1,33 +1,43 @@
 # How to contribute
 
-We are really glad you're reading this, because all the contributions to this project are helpful.
+We are really glad you're reading this, because all the contributions to this
+project are helpful.
 
-If you haven't already, please open an issue. We will talk about your idea and we want you working on things you're excited about.
+If you haven't already, please open an issue. We will talk about your idea and
+we want you working on things you're excited about.
 
 Here are some important resources:
 
-* [The official documentation](https://www.sonerezh.bzh/docs/en/)
-* [Our roadmap](https://roadmap.sonerezh.bzh/b/eCuz4jyhwjmxpxX8C/sonerezh-roadmap)
+* [The official documentation]
 
 ## Submitting changes
 
-Please send a [GitHub Pull Request to Sonerezh](https://github.com/Sonerezh/sonerezh/pull/new/development) with a clear list of what you've done (read more about [pull requests](http:https://help.github.com/pull-requests/)). Please, be sure you work on the ``development`` branch before ask for merge.
+Please send a [GitHub Pull Request to Sonerezh] with a clear list of what you've
+done (read more about [pull requests]).
 
-Always write a clear log message for your commits. One-line message are fine for small changes, but bigger changes should look like this:
+Always write a clear log message for your commits. One-line message are fine for
+small changes, but bigger changes should look like this:
 
  $ git commit -m "A brief summary of the commit
  >
  > A paragaph describing what changed and its impact."
 
-The branch ``master`` is used for production and for new releases. All the development is done on the branch ``development``.
-
 ## Coding convention
 
-Start reading our code and you'll get the hang of it. We optimize for readability:
+Start reading our code and you'll get the hang of it. We optimize for
+readability:
 
 * We indent using four spaces (no tabs)
-* As Sonerezh is built with CakePHP, we follow [their conventions](http:https://book.cakephp.org/2.0/en/getting-started/cakephp-conventions.html)
-* This is open source software. Consider the people who will read your code, and make it look nice for them. It's sort of like driving a car: Perhaps you love doing donuts when you're alone, but with passengers the goal is to make the ride as smooth as possible.
+* As Sonerezh is built with CakePHP, we follow [their conventions]
+* This is open source software. Consider the people who will read your code, and
+ make it look nice for them. It's sort of like driving a car: Perhaps you love
+ doing donuts when you're alone, but with passengers the goal is to make the
+ ride as smooth as possible.
 
 Thanks,
-Guillaume and Thomas
+Guillaume and Thomas
+
+[The official documentation]: (https://www.sonerezh.bzh)
+[GitHub Pull Request to Sonerezh]: (https://github.com/Sonerezh/sonerezh/pulls)
+[pull requests]: (http:https://help.github.com/pull-requests/)
+[their conventions]: (http:https://book.cakephp.org/2.0/en/getting-started/cakephp-conventions.html)

README.md

@@ -1,17 +1,20 @@
-Sonerezh
-========
+# Sonerezh
 
-A self-hosted, web-based application to stream your music, everywhere.
+Sonerezh is a self-hosted web application which allows you to listen to your
+music, from anywhere.
 
-Some Handy Links
-----------------
+All you have to do is to specify where your music is stored, and Sonerezh will
+build its database based on the audio file's metadata. Then you can browse your
+music library through a simple and intuitive Web UI.
 
-[Sonerezh official website](https://www.sonerezh.bzh).
+Let's try the latest version on [sonerezh.bzh/demo]!
 
-[Sonerezh documentation](https://www.sonerezh.bzh/docs/).
+Follow us on [Twitter] if you like the project, and don't forget to [support it
+making a donation].
 
-[Sonerezh source code, on GitHub](https://github.com/sonerezh/sonerezh).
+The documentation is available on [sonerezh.bzh].
 
-[Sonerezh on Twitter](https://twitter.com/snrzh).
-
-Don't forget to [support us](https://www.sonerezh.bzh/support) !
+[sonerezh.bzh/demo]: (https://www.sonerezh.bzh/demo/login)
+[Twitter]: (https://twitter.com/snrzh)
+[support it making a donation]: (https://www.sonerezh.bzh/donate)
+[sonerezh.bzh]: (https://www.sonerezh.bzh)

docs/README.md

@@ -0,0 +1,36 @@
+# Sonerezh documentation
+
+This is the documentation for the Sonerezh project.
+
+## How to build it
+
+The documentation is built with [MkDocs], a static site generator that's geared
+towards building project documentation.
+
+Documentation source files are written in Markdown, and configured with a
+single YAML configuration file.
+
+### Install MkDocs
+
+On Debian or Ubuntu platforms, just run:
+
+```text
+$ pip install mkdocs
+```
+
+### Get the documentation and contribute
+
+Clone this repository wherever you want to, and start writing.
+
+```text
+$ git clone https://github.com/Sonerezh/sonerezh.git
+$ cd sonerezh
+$ mkdocs serve
+```
+
+Then MkDocs builds the doc, and serves it on ``http:https://127.0.0.1:8000``.
+
+_Note: the Sonerezh theme for MkDocs just replaces the Google Analytics header
+with Matomo (formerly Piwik)_
+
+[MkDocs]: (https://www.mkdocs.org)

docs/about/license.md

@@ -0,0 +1,11 @@
+# License
+
+Legal stuff.
+
+---
+
+## Sonerezh license (AGPL-3.0)
+
+Sonerezh is generously offered under the GNU Affero General Public License v3.0.
+
+[View license](https://github.com/Sonerezh/sonerezh/blob/master/LICENCE.txt).

docs/css/style.css

@@ -0,0 +1,25 @@
+@font-face {
+ font-family:'Glyphicons Halflings';
+ src:url("../fonts/glyphicons-halflings-regular.eot");
+ src:url("../fonts/glyphicons-halflings-regular.eot?#iefix") format("embedded-opentype"), url("../fonts/glyphicons-halflings-regular.woff2") format("woff2"), url("../fonts/glyphicons-halflings-regular.woff") format("woff"), url("../fonts/glyphicons-halflings-regular.ttf") format("truetype"), url("../fonts/glyphicons-halflings-regular.svg#glyphicons_halflingsregular") format("svg");
+}
+
+div.col-md-9 h1:first-of-type {
+ text-align: center;
+}
+
+div.col-md-9>p:first-of-type {
+ text-align: center;
+}
+
+.icon {
+ font-family:'Glyphicons Halflings';
+}
+
+.icon.heart::before {
+ content:"\e005";
+}
+
+footer .icon {
+ color:red;
+}