ben slides.pdf

commit fdab914bf338b1bb6b60adf63500878760431f94
Author: Julie Zelenski <[email protected]>
Date:   Tue Dec 3 08:25:09 2024 -0800

    ben slides.pdf

Author: zelenski

lectures/Ben/CS107e_Magic_of_Systems.pdf renamed to lectures/Ben/slides.pdf

@@ -3,22 +3,33 @@ permalink: /project/supportcode
 title: 'Code extras'
 ---
 
-### Code available in `$CS107E/src` directory
-This directory contains our class code for Mango Pi. You are encouraged to use/adapt/learn from this code as part of your project.
-- Source code for all `libmango` support modules
-    - `ccu` `de` `font` `hdmi` `hstimer` `gpio_interrupt` `interrupts ` `mango` `ps2_keys` `ringbuffer` `uart`
-- Source for `spi` and `i2c` modules
+### Libmango and code extras
+You are encouraged to use/adapt/learn from any of our published code as part of your project.
+- `libmango`
+    - Library of our reference modules is `$CS107E/lib/libmango.a`
+        - Can also use your modules or your full library `libmymango.a`
+    - Source code for `libmango` support modules available in the `$CS107E/src` directory
+        - `ccu` `de` `font` `hdmi` `hstimer` `gpio_interrupt` `interrupts ` `mango` `ps2_keys` `ringbuffer` `uart`
+- `spi` and `i2c`
+    - source in <https://github.com/cs107e/cs107e.github.io/tree/master/lectures/Output/code/extras>
     - these drivers have been successfully used in past, minor recent updates to code
-- Source for `pwm` and `i2s` modules
-    - code for these peripherals is new and needs further testing
+- `pwm` and `i2s`
+    - Source in <https://github.com/cs107e/cs107e.github.io/tree/master/lectures/Output/code/extras>
+    - code for these modules is new and needs further testing
 
-### Extras
-
-The `$CS107E/extras` directory contains contributions shared by former students. Some of this code was written for Mango Pi, older code is for Raspberry Pi. These resources are not fully fleshed out, and we have not vetted the code.
+### Student extras
+The `$CS107E/extras` directory contains contributions shared by former students and bits of example code. Some of this code was written for Mango Pi, older code is for Raspberry Pi. Be aware the code may be incomplete or incorrect and the effort to port can range from minor nuisance to singificant rewrite.
 - `math_lib`: student's implementation of math functions
 - `neopixel`: sample code for Neopixel/WS8212 rgb led
 
-Your project is welcome to use/build on these resources, but be aware the code may be incomplete or incorrect and the effort to port can range from minor nuisance to singificant rewrite.  Be sure to cite the original and be clear about what the additional work you contributed when adopting it. Your project will be primarily evaluated on the portion of the work that is original.
+### Code found out in the wild
+Maker sites such as Adafruit, SparkFun, and DFRobot publish great tutorials and lots of example code. Their libraries tend to be well-tested and very complete, good resources to learn from!  Broad web search will unearth all kinds of random code on github and blogs; expect a hodge-podge in terms of quality and completeness. Note that code you find in the wild is very unlikely to be direct drop-in to our environment (RISC-V, Mango Pi, bare-metal), but studying the code can provide useful insights and a starting point for a port.
+
+### Citation
+If your project adopts from any resources you did not author yourself, they should be properly cited!
+- Citation should include author, url, what was used of their work
+- Explain what changes/extensions you contributed on top of the original (be specific)
+- Your project will be primarily evaluated the portion of the work that you contributed
 
 {% comment %}
 - Code to read/write files on the [SD card](extras/sd_library)