Update README.md for v0.1.0-beta

Author: danielljeon

README.md

@@ -4,6 +4,15 @@
 
 Nerve dev board using off-the-shelf modules.
 
+> **Note: This design is now no longer under active development. The final
+changes to the main branch are published as release tagged `v0.1.0-beta`,
+see the release notes: [1.1 v0.1.0-beta](#11-v010-beta).**
+
+> 💡**Hint:** To clone this repository use:
+> ```shell
+> git clone --recursive
+> ```
+
 ![nerve_ada_board.png](docs/nerve_ada_board.png)
 
 ---
@@ -13,26 +22,70 @@ Nerve dev board using off-the-shelf modules.
 
 <!-- TOC -->
 * [nerve_ada_board](#nerve_ada_board)
-  * [1 Overview](#1-overview)
-    * [1.1 Function Connectors](#11-function-connectors)
-    * [1.2 Switches & Jumpers](#12-switches--jumpers)
-    * [1.3 Plug-in Modules](#13-plug-in-modules)
-    * [1.4 Breakout Connectors](#14-breakout-connectors)
-  * [2 Development](#2-development)
-  * [3 Production History](#3-production-history)
-    * [3.1 v0.1.0-alpha-7b18788](#31-v010-alpha-7b18788)
+  * [1 Release Notes](#1-release-notes)
+    * [1.1 v0.1.0-beta](#11-v010-beta)
+      * [1.1.1 LSE Crystal](#111-lse-crystal)
+      * [1.1.2 External Clock Crystal Tuning](#112-external-clock-crystal-tuning)
+      * [1.1.3 GPS](#113-gps)
+  * [2 Overview](#2-overview)
+    * [2.1 Function Connectors](#21-function-connectors)
+    * [2.2 Switches & Jumpers](#22-switches--jumpers)
+    * [2.3 Plug-in Modules](#23-plug-in-modules)
+    * [2.4 Breakout Connectors](#24-breakout-connectors)
+  * [3 Development](#3-development)
+    * [3.1 Worflow](#31-worflow)
+    * [3.2 Submodules](#32-submodules)
+  * [4 Production History](#4-production-history)
+    * [4.1 v0.1.0-alpha-7b18788](#41-v010-alpha-7b18788)
 <!-- TOC -->
 
 </details>
 
 ---
 
-## 1 Overview
+## 1 Release Notes
+
+### 1.1 v0.1.0-beta
+
+Following the initial validation of components and software on this PCB design,
+development has shifted to a more production-oriented
+board: [nerve_pcb](https://github.com/danielljeon/nerve_pcb). While the base
+components remain similar, many have been modified, with further
+changes expected.
+
+During the development of the new design, several hardware and PCB issues were
+identified. Although this `README.md` will no longer be updated, the following
+sections document the known issues as of the final release.
+
+#### 1.1.1 LSE Crystal
+
+The current LSE crystal on the STM32F446RE is the ABS25-32.768KHZ-6-T.
+
+This is not the intended component; the correct crystal should have been the
+`ABS25-32.768KHZ-T`, which has a more appropriate load capacitance specification
+of 12.5 pF. The `ABS25-32.768KHZ-6-T` variant, with a 6 pF load capacitance, was
+used inadvertently.
+
+#### 1.1.2 External Clock Crystal Tuning
+
+The crystal circuits use calculated capacitors that have not yet been fully
+verified or fine-tuned. Specifically, the 32.768 kHz LSE crystal is likely using
+incorrect capacitors with a value of 1.5 pF.
+
+#### 1.1.3 GPS
+
+The GPS module (`SAM-M10Q`) had not been verified to be functional as of the
+release. However, this is likely due to software limitations rather than issues
+with the hardware or PCB design.
+
+---
+
+## 2 Overview
 
 Development board for the STM32
 based [nerve](https://github.com/danielljeon/nerve) controller firmware.
 
-### 1.1 Function Connectors
+### 2.1 Function Connectors
 
 These connectors are fixed by hardware (PCB traces or the connector itself).
 
@@ -45,7 +98,7 @@ These connectors are fixed by hardware (PCB traces or the connector itself).
 | CAN1 (Transceiver U7) | J7  | Pin 1: CAN1 High, Pin 2: CAN1 Low                                              |
 | CAN2 (Transceiver U8) | J8  | Pin 1: CAN2 High, Pin 2: CAN2 Low                                              |
 
-### 1.2 Switches & Jumpers
+### 2.2 Switches & Jumpers
 
 User controllable hardware and/or firmware driven inputs.
 
@@ -57,7 +110,7 @@ User controllable hardware and/or firmware driven inputs.
 | SDIO Card Detect Jumper | J4  | Close for card inserted (pull-down on close)   |
 | BOOT0 Jumper            | J5  | Open for run flash memory (pull-down on open)  |
 
-### 1.3 Plug-in Modules
+### 2.3 Plug-in Modules
 
 Off-the-shelf plug-in boards, primarily from Adafruit.
 
@@ -68,7 +121,7 @@ Off-the-shelf plug-in boards, primarily from Adafruit.
 | 4754                     |   U6   | Adafruit Industries LLC | 2.54 mm pitch TH   |        1 | BNO085 Module                    |
 | 5708                     | U7, U8 | Adafruit Industries LLC | 2.54 mm pitch TH   |        2 | TJA1051T/3 Module                |
 
-### 1.4 Breakout Connectors
+### 2.4 Breakout Connectors
 
 Simple breakout connectors, driven fully or partially by firmware. See schematic
 and firmware docs for details.
@@ -83,7 +136,9 @@ and firmware docs for details.
 
 ---
 
-## 2 Development
+## 3 Development
+
+### 3.1 Worflow
 
 Developed using KiCad with KiBot GitHub Actions
 workflow, [kibot.yaml](.github/workflows/kibot.yaml).
@@ -107,11 +162,32 @@ CI/CD objectives:
 6. CAD.
     - (`.step`).
 
+### 3.2 Submodules
+
+This repository includes the submodule `component_library`, located
+at: [component_library](https://github.com/danielljeon/component_library).
+
+When cloning the repository, make sure to use the recursive option:
+
+```shell
+git clone --recursive
+```
+
+To update the submodule to its latest version in a cloned repository, use the
+following command:
+
+> Note: This is not recommended for this deprecated repository, as pulling
+> updates from the submodule's latest commit may result in incompatibilities.
+
+```shell
+git submodule update --remote --merge
+```
+
 ---
 
-## 3 Production History
+## 4 Production History
 
-### 3.1 v0.1.0-alpha-7b18788
+### 4.1 v0.1.0-alpha-7b18788
 
 Commit: [7b18788](https://github.com/danielljeon/nerve_ada_board/commit/7b187884c03f280627d8443d2d9cc163f4b6956e).