From 998ac94f2814c41b48ef5f9b44e915c9990e453d Mon Sep 17 00:00:00 2001
From: ayabusa <79598408+ayabusa@users.noreply.github.com>
Date: Sun, 24 Mar 2024 13:54:56 +0100
Subject: [PATCH] Update README.md

---
 README.md | 35 +++++++++++++++++++++++++++++++++++
 1 file changed, 35 insertions(+)

diff --git a/README.md b/README.md
index 1dca34f..ed8f898 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,37 @@
 # Nucleo-bare-metal
 [WIP] my attempts to develop on my stm32 nuclo board
+## Building
+1. Install [gnu-arm-none-eabi](https://developer.arm.com/downloads/-/arm-gnu-toolchain-downloads) toolchain
+2. Clone the repo
+```
+git clone "https://github.com/ayabusa/Nucleo-bare-metal.git"
+cd Nucleo-bare-metal
+```
+3. Build the project (located in build/main.elf)
+```
+make all
+```
+## Running/Debuging
+```shell
+st-util                                 # Download at https://github.com/stlink-org/stlink, it launches the gdb server, port 4242
+gdb-multiarch main.elf                  # launch the gdb instance
+(gdb) target extended-remote :4242      # connect to the st-util server
+(gdb) load                              # load our binary
+(gdb) continue                          # run it
+```
+## Licence 
+```
+All Rights Reserved
+
+Copyright (c) 2024 ayabusa
+
+Created by ayabusa
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+```