From 2be3e1933ad2a41dcafa5fa93170627242c5b508 Mon Sep 17 00:00:00 2001
From: Tropicananass <hein.viz.ible@gmail.com>
Date: Mon, 6 Sep 2021 11:06:38 +0100
Subject: [PATCH]  cleaning readme

---
 RpiLedBars/README.md | 82 +++++++++++++++++++++++++++++---------------
 1 file changed, 54 insertions(+), 28 deletions(-)

diff --git a/RpiLedBars/README.md b/RpiLedBars/README.md
index 95bd5a8..07d2f15 100644
--- a/RpiLedBars/README.md
+++ b/RpiLedBars/README.md
@@ -1,59 +1,85 @@
-RpiLedBars
----
+# RpiLedBars
 
 LedBars version for raspberry pi
 
-contains :
+## Contains
 * a python test program (main.py)
 * a C program using :
   * ws2812 with dma/smi from Jeremy P Bentham - https://iosoft.blog/category/neopixel/
   * artnet from Stephan Ruloff - https://github.com/rstephan/ArtnetnodeWifi
 
-biblio:
-* Art-Net
-  * Protocol Spec : 
-    * https://art-net.org.uk/how-it-works/
-    * https://artisticlicence.com/WebSiteMaster/User%20Guides/art-net.pdf
-  * ESP32 library from Stephan Ruloff - https://github.com/rstephan/ArtnetnodeWifi
-* ws28** rgb leds
-  * ws2812 datasheet - https://cdn-shop.adafruit.com/datasheets/WS2812.pdf
-  * ws2815 datasheet - https://pdf1.alldatasheet.com/datasheet-pdf/view/1134588/WORLDSEMI/WS2815B.html 
-  * ws2812 with dma/smi from Jeremy P Bentham :
-    * ws2812 - https://iosoft.blog/2020/09/29/raspberry-pi-multi-channel-ws2812/
-    * dma - https://iosoft.blog/2020/05/25/raspberry-pi-dma-programming/
-    * smi - https://iosoft.blog/2020/07/16/raspberry-pi-smi/
+## Install
 
-Raspi Config :
-
-https://makersportal.com/blog/recording-stereo-audio-on-a-raspberry-pi
-https://learn.adafruit.com/adafruit-i2s-mems-microphone-breakout/raspberry-pi-wiring-test
+### I2S Microphone
 
+#### Install dependencies
+~~~bash
 sudo apt install python3-pip
 sudo pip3 install --upgrade adafruit-python-shell
+~~~
+
+#### Build and install module
+~~~bash
 cd /tmp
 sudo wget https://raw.githubusercontent.com/adafruit/Raspberry-Pi-Installer-Scripts/master/i2smic.py
 sudo python3 i2smic.py
+~~~
 
-# plug microphone
+After a kernel update this step as to be executed again (after reboot -> depends on `uname`)
+
+#### Test microphone
+
+Plug the microphone
+~~~bash
 sudo reboot
 arecord -l
 arecord -D plughw:1 -c1 -r 48000 -f S32_LE -t wav -V mono -v file.wav
+~~~
 
-# Control record volume
+#### Control record volume
+~~~bash
 cp res/.asoundrc ~/.asoundrc
+~~~
 
-# alsa API
-http://www.equalarea.com/paul/alsa-audio.html
+* Intall i2s mems microphone - https://learn.adafruit.com/adafruit-i2s-mems-microphone-breakout/raspberry-pi-wiring-test
+* Configuring alsa - https://makersportal.com/blog/recording-stereo-audio-on-a-raspberry-pi
+* Alsa API - http://www.equalarea.com/paul/alsa-audio.html
 
-# for project
+### Project depenencies
+
+~~~bash
 sudo apt install libasound2-dev wiringpi
+~~~
 
-# for cava
+#### Cava
+
+~~~bash
 sudo apt install libfftw3-dev libasound2-dev libtool automake
+cd cava
 ./autogen.sh
 ./configure
 make
 sudo make install
+~~~
 
-# Access point
-grep "Access point conf" $(find /etc -type f)
\ No newline at end of file
+### Access point
+
+~~~bash
+grep "Access point conf" $(find /etc -type f)
+~~~
+
+## Biblio:
+
+### Art-Net
+* Protocol Spec : 
+  * https://art-net.org.uk/how-it-works/
+  * https://artisticlicence.com/WebSiteMaster/User%20Guides/art-net.pdf
+* ESP32 library from Stephan Ruloff - https://github.com/rstephan/ArtnetnodeWifi
+
+### ws28xx rgb leds
+* ws2812 datasheet - https://cdn-shop.adafruit.com/datasheets/WS2812.pdf
+* ws2815 datasheet - https://pdf1.alldatasheet.com/datasheet-pdf/view/1134588/WORLDSEMI/WS2815B.html 
+* ws2812 with dma/smi from Jeremy P Bentham :
+  * ws2812 - https://iosoft.blog/2020/09/29/raspberry-pi-multi-channel-ws2812/
+  * dma - https://iosoft.blog/2020/05/25/raspberry-pi-dma-programming/
+  * smi - https://iosoft.blog/2020/07/16/raspberry-pi-smi/