Render README.qmd files to Markdown [skip ci]

README.md

@@ -1,8 +1,17 @@
-
+---
+editor: visual
+editor_options:
+  chunk_output_type: console
+execute:
+  echo: false
+  message: false
+  warning: false
+toc-title: Table of contents
+---
 
 # Smart System Education Platform
 
-## Location: /README.qmd
+## Location: /work/Smart-System-Platform/Smart-System-Platform/README.qmd
 
 ### Description
 
@@ -12,6 +21,8 @@ This is the main directory.
 
 The repository has the following directory tree.
 
+:::: cell
+::: {.cell-output .cell-output-stdout}
     .
     ├── LICENSE
     ├── README.md
@@ -24,14 +35,26 @@ The repository has the following directory tree.
     ├── project.Rproj
     ├── rstudio
     └── software
+:::
+::::
 
 A short description of the directories can be found below.
 
-| name | description | contribution |
-|----|----|----|
-| docs | This directory hosts the files for the website | Nick |
-| firmware | This directory hosts the firmware | Nick |
-| hardware | This directory hosts files and information about the hardware | Nick |
-| software | This directory includes libraries, custom libraries and example code, such as the for example the networking library | Nick |
-| overleaf | Latex Report Code | Nick |
-| rstudio | R Code | Nick |
+  -------------------------------------------------------------------------------------
+  name       description                                                 contribution
+  ---------- ----------------------------------------------------------- --------------
+  docs       This directory hosts the files for the website              Nick
+
+  firmware   This directory hosts the firmware                           Nick
+
+  hardware   This directory hosts files and information about the        Nick
+             hardware                                                    
+
+  software   This directory includes libraries, custom libraries and     Nick
+             example code, such as the for example the networking        
+             library                                                     
+
+  overleaf   Latex Report Code                                           Nick
+
+  rstudio    R Code                                                      Nick
+  -------------------------------------------------------------------------------------

docs/README.md

@@ -21,7 +21,7 @@ This directory hosts the website.
 
 The repository has the following directory tree.
 
-::: cell
+:::: cell
 ::: {.cell-output .cell-output-stdout}
     .
     ├── README.md
@@ -35,7 +35,7 @@ The repository has the following directory tree.
     ├── technology.html
     └── tools.html
 :::
-:::
+::::
 
 A short description of the directories can be found below.
 

firmware/README.md

@@ -21,14 +21,14 @@ This directory will host the custom firmware.
 
 The repository has the following directory tree.
 
-::: cell
+:::: cell
 ::: {.cell-output .cell-output-stdout}
     .
     ├── README.md
     ├── README.qmd
     └── README.rmarkdown
 :::
-:::
+::::
 
 A short description of the directories can be found below.
 

hardware/README.md

@@ -21,14 +21,14 @@ This directory will host files about the smart system hardware.
 
 The repository has the following directory tree.
 
-::: cell
+:::: cell
 ::: {.cell-output .cell-output-stdout}
     .
     ├── README.md
     ├── README.qmd
     └── README.rmarkdown
 :::
-:::
+::::
 
 A short description of the directories can be found below.
 

overleaf/README.md

@@ -21,14 +21,14 @@ This directory hosts the latex thesis report.
 
 The repository has the following directory tree.
 
-::: cell
+:::: cell
 ::: {.cell-output .cell-output-stdout}
     .
     ├── README.md
     ├── README.qmd
     └── README.rmarkdown
 :::
-:::
+::::
 
 A short description of the directories can be found below.
 

rstudio/README.md

@@ -21,15 +21,15 @@ This directory hosts the rstudio files.
 
 The repository has the following directory tree.
 
-::: cell
+:::: cell
 ::: {.cell-output .cell-output-stdout}
     .
     ├── README.md
     ├── README.qmd
     ├── README.rmarkdown
     └── exampleREADME.qmd
 :::
-:::
+::::
 
 A short description of the directories can be found below.
 

software/README.md

@@ -21,7 +21,7 @@ This directory hosts code for the smart modules.
 
 The repository has the following directory tree.
 
-::: cell
+:::: cell
 ::: {.cell-output .cell-output-stdout}
     .
     ├── README.md
@@ -33,6 +33,7 @@ The repository has the following directory tree.
     │   ├── README.qmd
     │   ├── boop-o-meters
     │   ├── display
+    │   ├── githubfiledownload
     │   ├── p2p
     │   └── ping
     ├── archive
@@ -58,7 +59,7 @@ The repository has the following directory tree.
         ├── examples
         └── networking.py
 :::
-:::
+::::
 
 A short description of the directories can be found below.
 

software/applications/README.md

@@ -1,8 +1,17 @@
-
+---
+editor: visual
+editor_options:
+  chunk_output_type: console
+execute:
+  echo: false
+  message: false
+  warning: false
+toc-title: Table of contents
+---
 
 # 
 
-#### Location: /software/tools/README.qmd
+#### Location: /work/Smart-System-Platform/Smart-System-Platform/software/applications/README.qmd
 
 ##### Description
 
@@ -12,6 +21,8 @@ This directory hosts the code.
 
 The repository has the following directory tree.
 
+:::: cell
+::: {.cell-output .cell-output-stdout}
     .
     ├── MnS
     │   ├── master.py
@@ -26,20 +37,38 @@ The repository has the following directory tree.
     ├── display
     │   ├── display.py
     │   └── networking_display.py
+    ├── githubfiledownload
+    │   └── filedownload.py
     ├── p2p
     │   └── main.py
     └── ping
         ├── echo.py
         └── shout.py
+:::
+::::
 
 A short description of the directories can be found below.
 
 A short description of the directories can be found below.
 
-| name | description | contribution |
-|----|----|----|
-| boop-o-meters | This code will allow you to send “boops” to any discovered mac address (i.e. every running smart motor that has networking.py initialised). It counts how many “boops” were sent and received. | Nick |
-| display | Displays discovered smart modules with networking enabled. | Nick |
-| MnS | This uses the networking code to control multiple smart motor using the sensor inputs of a “master” smart motor. The MAC is hard-coded. | Nick |
-| p2p | This uses the networking code to have smart motors use their partners sensor inputs. The MAC is hard-coded. If there is no stream of sensor data received from the partner, the smart motor reverts back and uses their own inputs. | Nick |
-| ping | Example code for pings and for returning pings (echo) | Nick |
+  ----------------------------------------------------------------------------------------------
+  name            description                                                     contribution
+  --------------- --------------------------------------------------------------- --------------
+  boop-o-meters   This code will allow you to send "boops" to any discovered mac  Nick
+                  address (i.e. every running smart motor that has networking.py  
+                  initialised). It counts how many "boops" were sent and          
+                  received.                                                       
+
+  display         Displays discovered smart modules with networking enabled.      Nick
+
+  MnS             This uses the networking code to control multiple smart motor   Nick
+                  using the sensor inputs of a "master" smart motor. The MAC is   
+                  hard-coded.                                                     
+
+  p2p             This uses the networking code to have smart motors use their    Nick
+                  partners sensor inputs. The MAC is hard-coded. If there is no   
+                  stream of sensor data received from the partner, the smart      
+                  motor reverts back and uses their own inputs.                   
+
+  ping            Example code for pings and for returning pings (echo)           Nick
+  ----------------------------------------------------------------------------------------------

software/libraries/README.md

@@ -1,8 +1,17 @@
-
+---
+editor: visual
+editor_options:
+  chunk_output_type: console
+execute:
+  echo: false
+  message: false
+  warning: false
+toc-title: Table of contents
+---
 
 # Smart System Education Platform
 
-## Location: /software/libraries/README.qmd
+## Location: /work/Smart-System-Platform/Smart-System-Platform/software/libraries/README.qmd
 
 ### Description
 
@@ -12,14 +21,21 @@ This directory hosts used and useful libraries.
 
 The repository has the following directory tree.
 
+:::: cell
+::: {.cell-output .cell-output-stdout}
     .
     ├── README.md
     ├── README.qmd
     ├── README.rmarkdown
     └── variableLED.py
+:::
+::::
 
 A short description of the directories can be found below.
 
-| name           | description                               | contribution |
-|----------------|-------------------------------------------|--------------|
-| variableLED.py | Library that powers the variable LED grid | Sophie       |
+  -------------------------------------------------------------------------
+  name             description                               contribution
+  ---------------- ----------------------------------------- --------------
+  variableLED.py   Library that powers the variable LED grid Sophie
+
+  -------------------------------------------------------------------------

software/networking/README.md

@@ -1,8 +1,17 @@
-
+---
+editor: visual
+editor_options:
+  chunk_output_type: console
+execute:
+  echo: false
+  message: false
+  warning: false
+toc-title: Table of contents
+---
 
 # Smart System Education Platform
 
-## Location: /software/networking/README.qmd
+## Location: /work/Smart-System-Platform/Smart-System-Platform/software/networking/README.qmd
 
 ### Description
 
@@ -22,22 +31,49 @@ Channels: 14
 
 The repository has the following directory tree.
 
+:::: cell
+::: {.cell-output .cell-output-stdout}
     .
     ├── README.md
     ├── README.qmd
     ├── README.rmarkdown
     ├── config.py
     ├── examples
+    │   ├── default_main.py
     │   ├── example.py
-    │   └── long_message_example.py
+    │   ├── long_message_example.py
+    │   └── pyscript_main.py
     └── networking.py
+:::
+::::
 
 A short description of the directories can be found below.
 
-| name | description | contribution |
-|----|----|----|
-| config.py | This file hosts configurations and secrets, such as the board name, WiFi name and password, as well as handshake keys which is used by some of the legacy networking code. | Nick |
-| examples | This directory hosts example code | Nick |
-| examples/example.py | This is some basic example code on how to use my networking library | Nick |
-| examples/long_message_example.py | This code showcases the long message capabilities built into my code. By sending multiple messages that are then stitched back together by the recipient the max payload can be increased from 241 bytes to 256 x 238 = 60928 bytes, although in reality the ESP32 boards will start running out of memory with messages above 30 kilobytes. | Nick |
-| networking.py | This is the main networking code that builds on ESP-NOW. There are many prepared functionalities (and some more that I am working on), such as long message support, sending of various variable types (bytes, bytearray, dicts, lists, int, float, char, string), as well as different types of messages such as ping, echo and more. There are also various features in place to make the networking more robust. It needs config.py to function. | Nick |
+  -----------------------------------------------------------------------------------------------------------------
+  name                               description                                                     contribution
+  ---------------------------------- --------------------------------------------------------------- --------------
+  config.py                          This file hosts configurations and secrets, such as the board   Nick
+                                     name, WiFi name and password, as well as handshake keys which   
+                                     is used by some of the legacy networking code.                  
+
+  examples                           This directory hosts example code                               Nick
+
+  examples/example.py                This is some basic example code on how to use my networking     Nick
+                                     library                                                         
+
+  examples/long_message_example.py   This code showcases the long message capabilities built into my Nick
+                                     code. By sending multiple messages that are then stitched back  
+                                     together by the recipient the max payload can be increased from 
+                                     241 bytes to 256 x 238 = 60928 bytes, although in reality the   
+                                     ESP32 boards will start running out of memory with messages     
+                                     above 30 kilobytes.                                             
+
+  networking.py                      This is the main networking code that builds on ESP-NOW. There  Nick
+                                     are many prepared functionalities (and some more that I am      
+                                     working on), such as long message support, sending of various   
+                                     variable types (bytes, bytearray, dicts, lists, int, float,     
+                                     char, string), as well as different types of messages such as   
+                                     ping, echo and more. There are also various features in place   
+                                     to make the networking more robust. It needs config.py to       
+                                     function.                                                       
+  -----------------------------------------------------------------------------------------------------------------