updated README

Paciente8159 · Jun 27, 2021 · 7132c6f · 7132c6f
1 parent 5e3aa21
commit 7132c6f
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -27,6 +27,7 @@ These include:
    - Added and RTC to the µCNC mcu HAL
    - Software configurable debounce delay for homming switches
    - Additional (configurable via build) option to emulate Grbl startup message to improve software compatibility (like Candle and others)
+   - Some important bug fixes in for the STM32F1 HAL
 
 ### G-Codes support
 µCNC for now supports most of the RS274NGC v3:
@@ -80,16 +81,17 @@ I used several UNO emulators but debugging was not easy. So a kind of virtual bo
 It can run on:
   - Arduino UNO
   - Arduino MEGA
-  - STM32F1 Blue Pill
+  - STM32F1 Blue Pill (with some limitations)
   - Windows PC (used for simulation only - ISR on Windows doesn't allow to use it a real alternative)
 
 ### µCNC roadmap
 Right now a couple of changes are being staged in µCNC to prepare for future and easier expansions.
 These changes are:
   - Add some extra functionalities like tool speed encoding, positional encoders, etc...
-  - Change the files path structure to be more organic and well organized
+  - Improvements to the HAL
+  - Change the files path structure to be more organic and well organized (this is already implemented for the next release)
   - Possibly integrate µCNC with Arduino IDE across all platforms
-  - Possibly move all USB stack related functionalities to a third-party library called [tinyUSB](https://github.com/hathach/tinyusb)
+  - Move all USB stack related functionalities to a third-party library called [tinyUSB](https://github.com/hathach/tinyusb) (this is already implemented for the next release)
   - Add more hardware configurations (SAMD21 developement has started)
 
 ### Building µCNC

diff --git a/uCNC/mcus/README.md b/uCNC/mcus/README.md
@@ -7,4 +7,6 @@
   2. You must also edit [mcus.h](https://github.com/Paciente8159/uCNC/blob/master/uCNC/mcus.h) and [mcudefs.h](https://github.com/Paciente8159/uCNC/blob/master/uCNC/mcudefs.h) to add you custom MCU.
 
   Compile it and test it.
+
+  For more detailed explanation please refer to the [wiki](https://github.com/Paciente8159/uCNC/wiki/Understanding-the-HAL#Creating-the-HAL-for-a-custom-MCU)
Original file line number	Diff line number	Diff line change
Expand Up		@@ -7,4 +7,6 @@
		2. You must also edit [mcus.h](https://github.com/Paciente8159/uCNC/blob/master/uCNC/mcus.h) and [mcudefs.h](https://github.com/Paciente8159/uCNC/blob/master/uCNC/mcudefs.h) to add you custom MCU.

		Compile it and test it.

		For more detailed explanation please refer to the [wiki](https://github.com/Paciente8159/uCNC/wiki/Understanding-the-HAL#Creating-the-HAL-for-a-custom-MCU)