From ec0afaed1f2d37e989b0318216093521d82d7c2e Mon Sep 17 00:00:00 2001
From: Kenzo Kowal <kenzo.kowal@astrolabe.coop>
Date: Fri, 3 Nov 2023 17:33:00 +0100
Subject: [PATCH] modification du readme et changement de nom pour la partie
 jitsi sur le whiteboard.onboard

---
 README             |  5 -----
 README.md          | 40 +++++++++++++++++++++++++++++++++++++---
 Whiteboard.onboard |  3 ++-
 3 files changed, 39 insertions(+), 9 deletions(-)
 delete mode 100644 README

diff --git a/README b/README
deleted file mode 100644
index ecebf43..0000000
--- a/README
+++ /dev/null
@@ -1,5 +0,0 @@
-Lancez le script.sh pour installer sur le raspberry pi les fichiers nécessaires
-pour la mise en place de la JitsiBox.
-Si vous voulez faire des modifications sur les boutons, vous devez modifier les fichiers key_defs ( fonction des touches ), Whiteboard.onboard et Whiteboard-Alpha.svg ( disposition des touches ).
-Pour modifier l'appareil à lequel vous allez vous connecter en bluetooth, modifiez l'adresse MAC qui se situe dans le fichier scripts/btconnect.sh.
-
diff --git a/README.md b/README.md
index a539975..cef3ef4 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,39 @@
 # AstroVisioBox
 
-Project inspirated from the Jitsi box project : https://github.com/openfun/jitsi-box/
-
-It's acomplete different project.
\ No newline at end of file
+Project inspirated from the Jitsi box project : https://github.com/openfun/jitsi-box/
+It's acomplete different project.
+
+## Installation
+
+Lunch script.sh on your raspberry, it will modify and add the files in the onboard repository, it will add the keyboard at the boot of the raspberry and lunch a chromium tab (with Jitsi Meet).
+You need to change the screen preferences, onboard keyboard will appear on the primary screen, if you want to change the configuration : 
+
+```onboard-settings```
+
+go to Window -> Settings -> change the Dock to monitor.
+
+The script changes the appearance of Onboard's whiteboard, you need to change the layout in order to see the changes : 
+
+```onboard-settings```
+
+go to Layout -> Contribution -> Whiteboard
+
+## Modification
+
+If you want to change the keybinds of the keyboard, modify files : key_defs.xml (touches fonctionnalities)
+
+```  <!-- jitsi buttons image= 'hand.png' -->```
+
+your scripts need to be placed in the script folder.
+
+Whiteboard.onboad and Whiteboard-Alpha.svg (touches display).
+
+If you want to add/remove the bluetooth device, change the MAC adress in the script/btconnect.sh.
+
+If you want to know the MAC adress of your device : 
+
+```bluetoothctl
+scan on
+```
+you will see your device with the MAC adress.
+
diff --git a/Whiteboard.onboard b/Whiteboard.onboard
index e165cb0..35091f6 100755
--- a/Whiteboard.onboard
+++ b/Whiteboard.onboard
@@ -44,7 +44,8 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
     <!--- word suggestions -->
     <panel filename="Whiteboard-Alpha.svg">
         <include file='word_suggestions.xml'/>
-      <!-- alpha layers -->
+
+      <!-- jitsi layers -->
        <panel filename="Whiteboard-Alpha.svg" layer="alpha">
           <key group="bottomrow" id="message" />
           <key group="bottomrow" id="micro" />