From c8986d35a902206c3c1364a3a3ba28dd85a63d25 Mon Sep 17 00:00:00 2001
From: alban <git@albancrommer.com>
Date: Sat, 27 Jan 2024 22:33:04 +0100
Subject: [PATCH] fix: edit specs

---
 README.md | 45 +++++++++++++++++++++++++--------------------
 1 file changed, 25 insertions(+), 20 deletions(-)

diff --git a/README.md b/README.md
index b8bf80e..46540b1 100644
--- a/README.md
+++ b/README.md
@@ -143,42 +143,47 @@ pub fn draw() -> Result<Vec<Point>, Box<dyn std::error::Error>> {
 
 ## OSC CONFIG
 
-S Server = (LJ) OSC Server and client
+### Actors and notations
+
+```
+- [S] Server / (LJ) OSC Server and client
 eventual config
  channel 1 : IP
  channel X : IP
 
-R Rust = (LJ Particle) OSC Server and Client
+- [R] Rust = (LJ Particle) OSC Server and Client
 
-U User Interface = (Tablet) HTML Interface
+- [U] User Interface = (Tablet) HTML Interface
 
-c Program Channel = configurable, uint ex: 1
-n Programe name = configurable, string ex: particle_foo_square
+- [c] Program Channel = configurable, uint ex: 1
+- [n] Programe name = configurable, string ex: particle_foo_square
 
-Sequence Diagram
+``` 
+
+### Sequence Diagram
 
 ```
-# Prerequisite : S is running and available and U is connected to S
-# R starts
-# R: Do you have my config already ?
-R -> S "/program/$c/$n/configure" 
+# Prerequisite : [S] is running and available and U is connected to [S]
+# [R] starts
+# [R]: Do you have my config already ?
+[R] -> [S] "/program/${c}/${n}/configure" 
 
-# C needs to stock which program is currently used for $n channel and its parameters
+# [S] needs to stock which program is currently used for ${n} channel and its parameters
 
-# If no, C manifests the need to init the configuration
-C -> R "/program/$c/$n/no-config"
+# If no, [S] manifests the need to init the configuration
+[S] -> [R] "/program/${c}/${n}/no-config"
 
-# If no-config, R sends its default config for C to store
-R -> C "/program/$c/$n/var1 default_value1" # etc.
+# If no-config, [R] sends its default config for [S] to store
+[R] -> [S] "/program/${c}/${n}/var1 default_value1" # etc.
 
-# In any case, C sends to R the current config
-C -> R "/program/$c/$n/var1 value1" # etc.
+# In any case, [S] sends to [R] the current config
+[S] -> [R] "/program/${c}/${n}/var1 value1" # etc.
 
-# C creates an event for the User to change  
-C -> U "/program/$c/$n" 
+# [S] creates an event for the User to change  
+[S] -> U "/program/${c}/${n}" 
 
 # U can change the program configuration 
-U -> C "/program/$c/$n" 
+U -> [S] "/program/${c}/${n}" 
 
 ```