Update README.asciidoc with credits

* Add external code links

diff --git a/README.asciidoc b/README.asciidoc
index a1cf29a1ba0cd23e1dbfd2c50a020219d8f65273..52fa2bd7c94c93ae774d4b0186d265c28ace1329 100644 (file)
--- a/README.asciidoc
+++ b/README.asciidoc
@@ -3,6 +3,10 @@ Diego Fratta <dfratta3@gatech.edu>; Anish Gajula <agajula7@gatech.edu>; Advaith
 v0.1.0, 2025-12-01
 :toc:
 :bucket: https://d191h8mmxs3x6q.cloudfront.net/madvaith1/ECE4180-resources/
 v0.1.0, 2025-12-01
 :toc:
 :bucket: https://d191h8mmxs3x6q.cloudfront.net/madvaith1/ECE4180-resources/

+:idf: https://github.com/espressif/esp-idf/tree/master/examples 
+:idfdoc: https://docs.espressif.com/projects/esp-idf/en/v5.5.1/esp32c6/index.html
+:imulnk: https://components.espressif.com/components/cybergear-robotics/icm20948/versions/0.1.0/readme?language=en 
+:debounz: https://components.espressif.com/components/espressif/button/versions/4.1.4/readme

 
 [.text-center]
 Authors: {authors}
 
 [.text-center]
 Authors: {authors}


@@ -12,7 +16,7 @@ uses Asciidoctor, the standard Asciidoc renderer to render AsciiDoc. If this
 feature is not supported, Asciidoc is very readable as plain text. This is also
 why it was chosen over Markdown.
 
 feature is not supported, Asciidoc is very readable as plain text. This is also
 why it was chosen over Markdown.
 

-* {bucket}ReportV2.pdf[Link to PDF form of this document]
+* {bucket}ReportV3.pdf[Link to PDF form of this document]

 * {bucket}CircuitDiagramV1.pdf[Link to PDF form of the circuit diagram]
 
 == Abstract
 * {bucket}CircuitDiagramV1.pdf[Link to PDF form of the circuit diagram]
 
 == Abstract


@@ -81,3 +85,27 @@ The Apple Watch does not have expandable storage support with SD cards.
   ordered in time. The team would have made a simpler, less compact THT version
   which would not have required as many complications, worrying about space
   layout in a future release.
   ordered in time. The team would have made a simpler, less compact THT version
   which would not have required as many complications, worrying about space
   layout in a future release.

+
+== Credits and License
+This code uses example code from the {idf}[ESP-IDF] repository, specifically the
+{idf}/get-started/hello_world[Hello World] as the starter template (has been
+largely modified except for the file name). Code for Wi-Fi was taken from
+{idf}/wifi/getting_started/station[Wi-Fi station example].
+
+The uLCD library has been ported from
+https://github.com/4dsystems/Goldelox-Serial-Linux-Library/[Goldelox Linux]
+library.
+
+Other code has been inferred from the comprehensive
+{idfdoc}[ESP-IDF Documentation],
+which contains function, constants and struct documentation.
+
+The code makes use of the {imulnk}[Cybergear Robotics ICM-20948] port of the
+Arduino library of the same name. To compile the project, the `SPI` files of the
+library need to be deleted. The team will eventually submit a pull request to
+the source to fix this issue.
+
+To deal with debouncing, the {debounz}[Button] library part of the ESP-IoT
+framework is used as well.
+
+The code is licensed under the GNU GPL v3.0.