Merge pull request #22 from tuftsceeo/main

catch up
tuftsceeo · Nov 26, 2024 · fd26ee3 · fd26ee3
2 parents 1be3b63 + f8416c0
commit fd26ee3
Show file tree

Hide file tree

Showing 23 changed files with 65 additions and 148 deletions.
diff --git a/.github/.DS_Store b/.github/.DS_Store
diff --git a/.github/workflows/render-README.yml b/.github/workflows/render-README.yml
@@ -43,5 +43,5 @@ jobs:
         #git checkout stage || git checkout -b stage
         
         git remote set-url origin https://x-access-token:${GITHUB_TOKEN}@github.com/${GITHUB_REPOSITORY}.git
-        
-        git push origin main
+        git push origin main
+
diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@
 
 # Smart System Education Platform
 
-## Location: /README.qmd
+## Location: /runner/work/Smart-System-Platform/README.qmd
 
 ### Description
 

diff --git a/README.qmd b/README.qmd
@@ -4,7 +4,6 @@ execute:
   echo: false
   message: false
   warning: false
-editor: visual
 editor_options: 
   chunk_output_type: console
 ---
@@ -13,8 +12,8 @@ editor_options:
 
 ```{r setup, include=FALSE}
 file_path <- fs::path_real("README.qmd")
-path_components <- strsplit(file_path, "/")[[1]]
-shortened_path <- fs::path_join(path_components[-c(2, 3)])
+path_components <- strsplit(as.character(file_path), "/")[[1]]
+shortened_path <- fs::path_join(path_components[-c(2:6)])
 ```
 
 ## Location: `r shortened_path`
@@ -27,7 +26,7 @@ This is the main directory.
 
 The repository has the following directory tree.
 
-```{r}
+```{r echo=FALSE}
 fs::dir_tree(recurse = FALSE)
 ```
 

diff --git a/docs/README.md b/docs/README.md
@@ -1,17 +1,8 @@
----
-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: /work/Smart-System-Platform/Smart-System-Platform/docs/README.qmd
+## Location: /runner/work/Smart-System-Platform/docs/README.qmd
 
 ### Description
 
@@ -21,8 +12,6 @@ This directory hosts the website.
 
 The repository has the following directory tree.
 
-::: cell
-::: {.cell-output .cell-output-stdout}
     .
     ├── README.md
     ├── README.qmd
@@ -34,16 +23,14 @@ The repository has the following directory tree.
     ├── start.html
     ├── technology.html
     └── tools.html
-:::
-:::
 
 A short description of the directories can be found below.
 
-  name              description              contribution
-  ----------------- ------------------------ --------------
-  index.html        Main page                Nick
-  mission.html      Mission statement        Nick
-  technology.html   Technology explanation   Nick
-  tools.html        Tool links               Nick
-  community.html    Community                Nick
-  start.html        ...                      Nick
+| name            | description            | contribution |
+|-----------------|------------------------|--------------|
+| index.html      | Main page              | Nick         |
+| mission.html    | Mission statement      | Nick         |
+| technology.html | Technology explanation | Nick         |
+| tools.html      | Tool links             | Nick         |
+| community.html  | Community              | Nick         |
+| start.html      | …                      | Nick         |
diff --git a/docs/README.qmd b/docs/README.qmd
@@ -14,7 +14,7 @@ editor_options:
 ```{r setup, include=FALSE}
 file_path <- fs::path_real("README.qmd")
 path_components <- strsplit(file_path, "/")[[1]]
-shortened_path <- fs::path_join(path_components[-c(2, 3)])
+shortened_path <- fs::path_join(path_components[-c(2:6)])
 ```
 
 ## Location: `r shortened_path`

diff --git a/firmware/README.md b/firmware/README.md
@@ -1,17 +1,8 @@
----
-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: /work/Smart-System-Platform/Smart-System-Platform/firmware/README.qmd
+## Location: /runner/work/Smart-System-Platform/firmware/README.qmd
 
 ### Description
 
@@ -21,17 +12,13 @@ This directory will host the custom firmware.
 
 The repository has the following directory tree.
 
-::: cell
-::: {.cell-output .cell-output-stdout}
     .
     ├── README.md
     ├── README.qmd
     └── README.rmarkdown
-:::
-:::
 
 A short description of the directories can be found below.
 
-  name   description   contribution
-  ------ ------------- --------------
-  NA     NA            Nick
+| name | description | contribution |
+|------|-------------|--------------|
+| NA   | NA          | Nick         |
diff --git a/firmware/README.qmd b/firmware/README.qmd
@@ -14,7 +14,7 @@ editor_options:
 ```{r setup, include=FALSE}
 file_path <- fs::path_real("README.qmd")
 path_components <- strsplit(file_path, "/")[[1]]
-shortened_path <- fs::path_join(path_components[-c(2, 3)])
+shortened_path <- fs::path_join(path_components[-c(2:6)])
 ```
 
 ## Location: `r shortened_path`

diff --git a/hardware/README.md b/hardware/README.md
@@ -1,17 +1,8 @@
----
-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: /work/Smart-System-Platform/Smart-System-Platform/hardware/README.qmd
+## Location: /runner/work/Smart-System-Platform/hardware/README.qmd
 
 ### Description
 
@@ -21,17 +12,13 @@ This directory will host files about the smart system hardware.
 
 The repository has the following directory tree.
 
-::: cell
-::: {.cell-output .cell-output-stdout}
     .
     ├── README.md
     ├── README.qmd
     └── README.rmarkdown
-:::
-:::
 
 A short description of the directories can be found below.
 
-  name   description   contribution
-  ------ ------------- --------------
-  NA     NA            Nick
+| name | description | contribution |
+|------|-------------|--------------|
+| NA   | NA          | Nick         |
diff --git a/hardware/README.qmd b/hardware/README.qmd
@@ -14,7 +14,7 @@ editor_options:
 ```{r setup, include=FALSE}
 file_path <- fs::path_real("README.qmd")
 path_components <- strsplit(file_path, "/")[[1]]
-shortened_path <- fs::path_join(path_components[-c(2, 3)])
+shortened_path <- fs::path_join(path_components[-c(2:6)])
 ```
 
 ## Location: `r shortened_path`

diff --git a/overleaf/README.md b/overleaf/README.md
@@ -1,17 +1,8 @@
----
-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: /work/Smart-System-Platform/Smart-System-Platform/overleaf/README.qmd
+## Location: /runner/work/Smart-System-Platform/overleaf/README.qmd
 
 ### Description
 
@@ -21,17 +12,13 @@ This directory hosts the latex thesis report.
 
 The repository has the following directory tree.
 
-::: cell
-::: {.cell-output .cell-output-stdout}
     .
     ├── README.md
     ├── README.qmd
     └── README.rmarkdown
-:::
-:::
 
 A short description of the directories can be found below.
 
-  name   description   contribution
-  ------ ------------- --------------
-  NA     NA            Nick
+| name | description | contribution |
+|------|-------------|--------------|
+| NA   | NA          | Nick         |
diff --git a/overleaf/README.qmd b/overleaf/README.qmd
@@ -14,7 +14,7 @@ editor_options:
 ```{r setup, include=FALSE}
 file_path <- fs::path_real("README.qmd")
 path_components <- strsplit(file_path, "/")[[1]]
-shortened_path <- fs::path_join(path_components[-c(2, 3)])
+shortened_path <- fs::path_join(path_components[-c(2:6)])
 ```
 
 ## Location: `r shortened_path`

diff --git a/rstudio/README.md b/rstudio/README.md
@@ -1,17 +1,8 @@
----
-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: /work/Smart-System-Platform/Smart-System-Platform/rstudio/README.qmd
+## Location: /runner/work/Smart-System-Platform/rstudio/README.qmd
 
 ### Description
 
@@ -21,22 +12,14 @@ This directory hosts the rstudio files.
 
 The repository has the following directory tree.
 
-::: cell
-::: {.cell-output .cell-output-stdout}
     .
     ├── README.md
     ├── README.qmd
     ├── README.rmarkdown
     └── exampleREADME.qmd
-:::
-:::
 
 A short description of the directories can be found below.
 
-  ---------------------------------------------------------------------------------
-  name                description                                    contribution
-  ------------------- ---------------------------------------------- --------------
-  exampleREADME.qmd   This is the example README used to generate    Nick
-                      all the README.md                              
-
-  ---------------------------------------------------------------------------------
+| name | description | contribution |
+|----|----|----|
+| exampleREADME.qmd | This is the example README used to generate all the README.md | Nick |
diff --git a/rstudio/README.qmd b/rstudio/README.qmd
@@ -14,7 +14,7 @@ editor_options:
 ```{r setup, include=FALSE}
 file_path <- fs::path_real("README.qmd")
 path_components <- strsplit(file_path, "/")[[1]]
-shortened_path <- fs::path_join(path_components[-c(2, 3)])
+shortened_path <- fs::path_join(path_components[-c(2:6)])
 ```
 
 ## Location: `r shortened_path`

diff --git a/rstudio/exampleREADME.qmd b/rstudio/exampleREADME.qmd
@@ -14,7 +14,7 @@ editor_options:
 ```{r setup, include=FALSE}
 file_path <- fs::path_real("README.qmd")
 path_components <- strsplit(file_path, "/")[[1]]
-shortened_path <- fs::path_join(path_components[-c(2, 3)])
+shortened_path <- fs::path_join(path_components[-c(2:6)])
 ```
 
 ## Location: `r shortened_path`

diff --git a/software/README.md b/software/README.md
@@ -1,17 +1,8 @@
----
-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: /work/Smart-System-Platform/Smart-System-Platform/software/README.qmd
+## Location: /runner/work/Smart-System-Platform/software/README.qmd
 
 ### Description
 
@@ -21,8 +12,6 @@ This directory hosts code for the smart modules.
 
 The repository has the following directory tree.
 
-::: cell
-::: {.cell-output .cell-output-stdout}
     .
     ├── README.md
     ├── README.qmd
@@ -33,6 +22,7 @@ The repository has the following directory tree.
     │   ├── README.qmd
     │   ├── boop-o-meters
     │   ├── display
+    │   ├── githubfiledownload
     │   ├── p2p
     │   └── ping
     ├── archive
@@ -57,28 +47,21 @@ The repository has the following directory tree.
         ├── config.py
         ├── examples
         └── networking.py
-:::
-:::
 
 A short description of the directories can be found below.
 
-  ------------------------------------------------------------------------
-  name           description                                contribution
-  -------------- ------------------------------------------ --------------
-  libraries      Useful libraries for inputs and outputs    Nick
-
-  networking     Smart Module Networking library            Nick
-
-  applications   Various coding tools and applications      Nick
-
-  archive        Old or outdated code or examples           Nick
-  ------------------------------------------------------------------------
+| name         | description                             | contribution |
+|--------------|-----------------------------------------|--------------|
+| libraries    | Useful libraries for inputs and outputs | Nick         |
+| networking   | Smart Module Networking library         | Nick         |
+| applications | Various coding tools and applications   | Nick         |
+| archive      | Old or outdated code or examples        | Nick         |
 
 ### Helpful links:
 
-ESP-NOW <https://docs.micropython.org/en/latest/library/espnow.html>\
+ESP-NOW <https://docs.micropython.org/en/latest/library/espnow.html>  
 Networking
-<https://docs.micropython.org/en/latest/library/network.html>\
+<https://docs.micropython.org/en/latest/library/network.html>  
 AP / WiFi
 <https://docs.micropython.org/en/latest/library/network.WLAN.html>