Started github doc

Readme.md

@@ -0,0 +1,48 @@
+# minichord 
+
+This repository contains the source file both for the minichord itself and its documentation. 
+
+## Documentation 
+
+The best way to get to know this project is to visit the [minichord website](https://minichord.com/) which contains the documentation of the project. 
+
+In particular:
+
+- the [user manual of the minichord](https://minichord.com/user_manual/)
+- the [assembly guide of the minichord](https://minichord.com/assembly/)
+
+This documentation is build with mkdocs and the relevant source and build script is available in the [documentation folder](https://github.com/BenjaminPoilve/MiniChord/tree/main/documentation).
+
+## Hardware 
+
+The hardware folder contains the necessary ressources to build a minichord. 
+
+All hardware is provided under a Creative Commons Attribution-NonCommercial 4.0 International Public
+License (CC BY-NC 4.0). 
+
+In particular: 
+
+- the [files necessary to manufacture the PCB](https://github.com/BenjaminPoilve/MiniChord/tree/main/hardware/PCB)
+- the [full BOM of the project](https://github.com/BenjaminPoilve/MiniChord/tree/main/hardware/BOM)
+- the [3D enclosure files](https://github.com/BenjaminPoilve/MiniChord/tree/main/hardware/3D/rendering)
+- the [keycap routing files](https://github.com/BenjaminPoilve/MiniChord/tree/main/hardware/graphics)
+
+## Firmware 
+
+The firmware folder contains the project firmware and necessary programming ressources.
+
+In particular: 
+- the [Hex firmware](https://github.com/BenjaminPoilve/MiniChord/blob/main/firmware/firmware.hex)
+- the full [PlatformIO project](https://github.com/BenjaminPoilve/MiniChord/tree/main/firmware)
+- the [minicontrol software](https://github.com/BenjaminPoilve/MiniChord/tree/main/firmware/mini_control)
+
+## Media 
+
+Here is a list of available media related to the project (to be completed) :
+
+- a technical video about [the minicontrol system](https://www.youtube.com/watch?v=h-6qkhU_WoA&t=933s)
+- a short [audio demo of selected presets](https://minichord.com/ressources/audio_demo.mp3)
+
+## Contact 
+
+For any information about the project, don't hesitate to write at [email protected]

documentation/Readme.md

@@ -0,0 +1,20 @@
+# Documentation 
+
+This folder contains all the necessary files to build the documentation 
+
+## Installation of mkdocs 
+To install using python3, follow those steps:
+
+* `pip3 install mkdocs`
+* `pip3 install mkdocs-terminal` 
+* add `/Users/{user_name}/Library/Python/3.8/binv` to `/etc/paths`  (on OSX)
+
+## Usage 
+
+Modifications should be made in the [docs folder](https://github.com/BenjaminPoilve/MiniChord/tree/main/documentation/docs).
+
+To be able to have a live view, use the `mkdocs serve` command and open the indicated URL in your browser. 
+
+The home page itself is coded manually (the `index.html`file). 
+
+Once changes are made use the `build_site.sh` script to build the full website (this scripts builds the mkdocs files then copies the additional ressources).

documentation/docs/source.md

@@ -28,7 +28,7 @@ License (CC BY-NC 4.0)
 ## Electronics
 
 
-* [Full BOM](https://github.com/BenjaminPoilve/MiniChord/blob/main/hardware/full_BOM.pdf)
+* [Full BOM](https://github.com/BenjaminPoilve/MiniChord/blob/main/hardware/BOM/full_BOM.pdf)
 * [Main PCB schematics](https://github.com/BenjaminPoilve/MiniChord/blob/main/hardware/PCB/miniChord_main_PCB/MiniChord.pdf)
 * [Main PCB Gerber file](https://github.com/BenjaminPoilve/MiniChord/tree/main/hardware/PCB/miniChord_main_PCB/gerber)
 * [Touch zone PCB schematics](https://github.com/BenjaminPoilve/MiniChord/blob/main/hardware/PCB/additional%20PCB/touch_zone.pdf)

hardware/Readme.md

@@ -0,0 +1,22 @@
+# Hardware  
+
+This folder contains the necessary ressources to build a minichord. 
+
+### Electronics
+
+* [Main PCB schematics](https://github.com/BenjaminPoilve/MiniChord/blob/main/hardware/PCB/miniChord_main_PCB/MiniChord.pdf)
+* [Main PCB Gerber file](https://github.com/BenjaminPoilve/MiniChord/tree/main/hardware/PCB/miniChord_main_PCB/gerber)
+* [Touch zone PCB schematics](https://github.com/BenjaminPoilve/MiniChord/blob/main/hardware/PCB/additional%20PCB/touch_zone.pdf)
+* [Touch zone PCB Gerber file](https://github.com/BenjaminPoilve/MiniChord/tree/main/hardware/PCB/additional%20PCB/gerber)
+### BOM
+
+* [Full BOM](https://github.com/BenjaminPoilve/MiniChord/blob/main/hardware/BOM/full_BOM.pdf)
+
+### 3D files
+
+* [Bottom shell](https://github.com/BenjaminPoilve/MiniChord/blob/main/hardware/3D/rendering/render_v9_bottom.scad.stl) 
+* [Top shell](https://github.com/BenjaminPoilve/MiniChord/blob/main/hardware/3D/rendering/render_v9_top1_5.scad.stl)
+
+### 2D files 
+
+* [Key engraving](https://github.com/BenjaminPoilve/MiniChord/blob/main/hardware/graphics/key_engraving.svg)