Fix: comments, READMEs and authorship

Author: Dajamante

README.md

@@ -386,20 +386,7 @@ TODO
 
 ## Build Requirements
 
-1. rustup and Rust
-   - see https://www.rust-lang.org
-2. The `thumbv6m-none-eabi` target
-   - run `rustup target add thumbv6m-none-eabi`
-3. `probe-run`
-   - run `cargo install probe-run` from your `$HOME` dir (not this folder!)
-4. `flip-link`
-   - run `cargo install flip-link` from your `$HOME` dir (not this folder!)
-
-Then to build and flash, connect a probe supported by probe-rs (such as a SEGGER J-Link, or an ST-Link) and run:
-
-```
-$ cargo run --bin neotron-bmc --release
-```
+Build requirements are available for [Neotron-BMC-pico](neotron-bmc-pico/README.md) and [Neotron-BMC-nucleo](neotron-bmc-nucleo/README.md). 
 
 ## Licence
 

neotron-bmc-nucleo/Cargo.toml

@@ -1,5 +1,5 @@
 [package]
-authors = ["Jonathan 'theJPster' Pallant <[email protected]>"]
+authors = ["Jonathan 'theJPster' Pallant <[email protected]>", "Aïssata 'Ai' Maiga <[email protected]>"]
 name = "neotron-bmc-nucleo"
 edition = "2018"
 version = "0.2.0"

neotron-bmc-nucleo/README.md

@@ -21,5 +21,5 @@ TODO: copy here from main Readme?
 Then to build and flash, connect a probe supported by probe-rs (such as a SEGGER J-Link, or an ST-Link) and run:
 
 ```
-$ cargo run --bin neotron-bmc-nucleo --release
+$ cargo run --release
 ```

neotron-bmc-nucleo/build.rs

@@ -1,6 +1,6 @@
-/// This is the build-script for the Neotron BMC.
-///
-/// It just copies the memory.x file somewhere Cargo can find it, then generates a version header.
+//! This is the build-script for the Neotron BMC.
+//!
+//! It just copies the memory.x file somewhere Cargo can find it, then generates a version header.
 use std::env;
 use std::fs::File;
 use std::io::Write;

neotron-bmc-nucleo/src/main.rs

@@ -78,7 +78,6 @@ pub struct RegisterState {
 	firmware_version: &'static str,
 }
 
-//USB is not a name of an interrupt
 #[app(device = crate::pac, peripherals = true, dispatchers=[USART2])]
 mod app {
 
@@ -223,25 +222,25 @@ mod app {
 				gpioa.pa10.into_alternate(),
 				gpioa.pa11.into_alternate(),
 				gpioa.pa12.into_alternate(),
-				//power led
+				// power led
 				gpioc.pc1.into_push_pull_output(),
 				// status led
 				gpioc.pc2.into_push_pull_output(),
 				// power button
 				gpioc.pc13.into_pull_up_input(),
 				// reset button
 				gpiob.pb12.into_pull_up_input(),
-				//dc on
+				// dc on
 				gpioc.pc0.into_push_pull_output(),
 				// system reset
 				gpiob.pb15.into_push_pull_output(),
-				//PS2_CLK0
+				// PS2_CLK0
 				gpioc.pc5.into_floating_input(),
-				//PS2_CLK1
+				// PS2_CLK1
 				gpiob.pb0.into_floating_input(),
-				//PS2_DAT0
+				// PS2_DAT0
 				gpiob.pb1.into_floating_input(),
-				//PS2_DAT1
+				// PS2_DAT1
 				gpiob.pb2.into_floating_input(),
 			)
 		});
@@ -312,7 +311,6 @@ mod app {
 			},
 			kb_q_in,
 			kb_q_out,
-			// SEEMS GONE:
 			ms_decoder: Ps2Decoder::new(),
 		};
 

neotron-bmc-pico/README.md

@@ -21,5 +21,5 @@ TODO: copy here from main Readme?
 Then to build and flash, connect a probe supported by probe-rs (such as a SEGGER J-Link, or an ST-Link) and run:
 
 ```
-$ cargo run --bin neotron-bmc --release
+$ cargo run --release
 ```

neotron-bmc-pico/build.rs

@@ -1,6 +1,6 @@
-/// This is the build-script for the Neotron BMC.
-///
-/// It just copies the memory.x file somewhere Cargo can find it, then generates a version header.
+//! This is the build-script for the Neotron BMC.
+//!
+//! It just copies the memory.x file somewhere Cargo can find it, then generates a version header.
 use std::env;
 use std::fs::File;
 use std::io::Write;