Musicoll · eliottparis · Jan 20, 2019 · Jan 15, 2019 · Jan 15, 2019 · Jan 15, 2019
diff --git a/README.md b/README.md
@@ -1,7 +1,5 @@
 <p align="center">
-  <h1 align="center">
-    <img src="https://github.com/Musicoll/Kiwi/blob/master/Resources/BinaryRes/Images/kiwi_icon.png" height=40px/> Kiwi
-  </h1>
+  <h1 align="center">Kiwi</h1>
   <p align="center">
     A real-time collaborative audio patching software
   </p>
@@ -18,9 +16,16 @@
 
 ### Presentation
 
-Kiwi is part of the French ANR-funded [MUSICOLL](http://musicoll.mshparisnord.org/) project that unites the [CICM](http://cicm.mshparisnord.org/) and [OhmForce](https://www.ohmforce.com/Company.do). The main goal of this project is to study how collaboration can enhance the way digital audio music composition is taught and more generally how it can improve music creation workflow. It enables several creators to work simultaneously on a same patch hosted online and accessible from any connected terminal.
+Kiwi is a graphical programming environment dedicated to music and sound creation, such as [Max](https://cycling74.com) or [Pure Data](https://puredata.info/) softwares, but offering a real-time collaborative approach: Kiwi allows several distant users to work simultaneously on the same patch hosted online.
 
-<img title="register" src="https://raw.github.com/Musicoll/Kiwi/master/docs/img/Kiwi-v1.0.0.jpg" height=400px/>
+![Kiwi Screenshot](docs/img/kiwi_screenshot.png)
+
+Kiwi is part of the French ANR-funded [MUSICOLL](http://musicoll.mshparisnord.org/) project that unites the [CICM](http://cicm.mshparisnord.org/) and [OhmForce](https://www.ohmforce.com/). The main goal of this project is to study how collaboration can enhance the way digital audio music composition is taught and more generally how it can improve music creation workflow.
+
+- You can [download the latest version](https://github.com/Musicoll/Kiwi/releases) in the release page : [![Release](https://img.shields.io/github/release/Musicoll/Kiwi.svg)](https://github.com/Musicoll/Kiwi/releases)
+- Access online software [documentation](http://musicoll.github.io/Kiwi)
+
+---
 
 ### Compilation
 
@@ -54,9 +59,24 @@ npm install -g github-wikito-converter
 ```
 Then, from the **Kiwi root** folder, run:
 ```
-python ./Script/gendoc.py
+python ./Scripts/gendoc.py
 ```
 
+---
+
+### Authors
+
+[![Eliott Paris](https://avatars.githubusercontent.com/u/1750257?s=90)](https://github.com/eliottparis) | [![Pierre Guillot](https://avatars.githubusercontent.com/u/1409918?s=90)](https://github.com/pierreguillot) | [![Jean Millot](https://avatars.githubusercontent.com/u/16612690?s=90)](https://github.com/jean-millot)
+---|---|---
+[Eliott Paris](https://github.com/eliottparis) | [Pierre Guillot](https://github.com/pierreguillot) | [Jean Millot](https://github.com/jean-millot)
+
+### Papers
+
+- E. Paris, *Une Approche du patching audio collaboratif : Enjeux et développement du collecticiel Kiwi*, thèse de doctorat, sous la direction d'A. Sèdes et A. Bonardi, Université de Paris 8, 2018 - [URL](https://hal.archives-ouvertes.fr/tel-01970169v1) (fr).
+- P. Galleron, E. Maestri, J. Millot, A. Bonardi, E. Paris, *Enseigner le patching de manière collective avec le logiciel collaboratif Kiwi*, Journées d’Informatique Musicale (JIM 2018), 2018, Amiens, France, pp.105-114. [URL](https://hal.archives-ouvertes.fr/hal-01791492/document) (fr).
+- E. Paris, J. Millot, P. Guillot, A. Bonardi, A. Sèdes, *Kiwi : Vers un environnement de creation musicale temps reel collaboratif*, Journées d’Informatique Musicale (JIM 2017), 2017, Paris, France. [URL](https://hal.archives-ouvertes.fr/hal-01550190/document) (fr).
+- A. Sèdes, A. Bonardi, E. Paris, J. Millot, P. Guillot, *Teaching, investigating, creating: MUSICOLL*. Innovative Tools and Methods for Teaching Music and Signal Processing, 2017. [URL](https://hal.archives-ouvertes.fr/hal-01581698/document) (en).
+
 ### Organizations
 
 - [ANR MUSICOLL](http://musicoll.mshparisnord.org)
@@ -65,12 +85,6 @@ python ./Script/gendoc.py
 - [MSH Paris Nord](https://www.mshparisnord.fr)
 - [Université Paris 8](https://www.univ-paris8.fr)
 
-### Authors
-
-- [Eliott PARIS](https://github.com/eliottparis)
-- [Pierre GUILLOT](https://github.com/pierreguillot)
-- [Jean MILLOT](https://github.com/jean-millot)
-
 ### Credits
 
 - [Flip](http://developer.irisate.com/)
@@ -83,12 +97,6 @@ python ./Script/gendoc.py
 - [FAUST](https://github.com/grame-cncm/faust.git)
 - [Icons by Freepik](https://www.flaticon.com/)
 
-### Papers
-
-- [JIM 2017 - Kiwi : Vers un environnement de creation musicale temps reel collaboratif](https://hal.archives-ouvertes.fr/hal-01550190/document)
-- [JIM 2018 - Enseigner le patching de manière collective avec le logiciel collaboratif Kiwi](https://hal.archives-ouvertes.fr/hal-01791492/document).
-- [Teaching, investigating, creating: MUSICOLL](https://hal.archives-ouvertes.fr/hal-01581698v1)
-
 ### License
 
 The Kiwi application is licensed under the terms of the [GNU GPL-3.0](https://github.com/Musicoll/Kiwi/blob/master/Licence.md) license. However, Kiwi also depends on the [Flip](http://developer.irisate.com/) library which is NOT open-source.
diff --git a/Resources/doctogen/_Sidebar.md b/Resources/doctogen/_Sidebar.md
@@ -1,11 +1,15 @@
-# English
+### Getting Started
 
-- [Getting Started](getting-started-en.md)
-- [Objects List](objects-en.md)
-- [Examples](examples-en.md)
+- [Presentation](presentation.md)
+- [Installation](installing.md)
+- [Quick Tour](quick-tour.md)
+- [Patching](patching.md)
+- [Register/Login](login.md)
+- [Collaborate](collaborate.md)
 
-# Français
+### Details
 
-- [Premiers pas](getting-started-fr.md)
-- [Liste des objets](objects-fr.md)
-- [Exemples](exemples-fr.md)
+- [Objects](help-patches.md)
+- [Objects list](objects-list.md)
+- [Examples](examples.md)
+- [Shortcuts](shortcuts.md)
diff --git a/Resources/doctogen/collaborate.md b/Resources/doctogen/collaborate.md
@@ -0,0 +1,26 @@
+In this section we will describe how one can join a patch and collaborate with other users. Once you are logged in, you can access the remote documents from the document browser window.
+
+<img title="first patch" src="./img/document_browser.png" height="500" class="centered">
+
+As you can see the window displays a list of documents accessible online. They can be access by anyone connected to the same server. You can download, delete, upload, rename, duplicate patches from this window by right clicking on an item. Sorting documents using various criteria is also possible.
+
+Double click on a document to join an online session and start collaborating with other users. You can click on the top left icon of the patcher to show the users that are currently editing or playing with the patch.
+
+<img alt="user list popup" src="./img/patcher_connected_user_list_popup.png" width="250">
+<img alt="FM Synth collaborate" src="./img/FM_synth_collab.png" width="500">
+
+Objects currently selected by other users are highlighted in <span class="inline-block orange">orange</span>, whereas your own selection is shown in <span class="inline-block blue">blue</span>.
+
+You can now edit and/or play the patch as you will with the others in realtime. Every modification you make in the structure of the patch will automatically be synced between peers and saved on the server.
+
+On the other hand, when you play with the patch, its state is not shared with the others. Indeed the execution of the patch stay local so you can control parameters independently and isolate or customize audio rendering.
+
+| User A | User B |
+|:---:|:---:|
+| <img alt="User A" src="./img/kiwi_play_video_number.gif"/> | <img alt="User B" src="./img/kiwi_play_video_slider.gif"/> |
+
+If you want to share some data of the patch with other users or synchronize GUI objects, you can do it via a specific object of the language called a **hub** that broadcasts messages to every users connected to the same document through the server.
+
+<img alt="Using the kiwi hub object" src="./img/hub_server_communication.png" width="600" class="centered"/>
+
+> Open the **hub** help patch in the Help menu for more infos
diff --git a/Resources/doctogen/examples-en.md b/Resources/doctogen/examples-en.md
diff --git a/Resources/doctogen/examples.md b/Resources/doctogen/examples.md
@@ -0,0 +1,28 @@
+A set of examples is provided in the Kiwi documentation. To explore them, simply go to the main software menu `Help/Examples`.
+
+Each example aims at taking you through the creation of a specific audio processing or exploring a certain aspect of Kiwi :
+
+| Fx                                    |
+|---------------------------------------|
+| flanger                               |
+| granular                              |
+| oscillo-pan                           |
+| overlapped pitchshifter               |
+| simple delay                          |
+| simple pitchshifter                   |
+
+| synthesis                             |
+|---------------------------------------|
+| additive synthesis                    |
+| Chowning FM with Pan                  |
+| Chowning FM                           |
+| Kontakte                              |
+| odd harmonic gen 1                    |
+| odd harmonic gen 2                    |
+| odd harmonic gen 3                    |
+| odd harmonic gen 3                    |
+| Risset's Bell                         |
+
+| others                                |
+|---------------------------------------|
+| play and record files             
diff --git a/Resources/doctogen/exemples-fr.md b/Resources/doctogen/exemples-fr.md
diff --git a/Resources/doctogen/getting-started-en.md b/Resources/doctogen/getting-started-en.md