From fc6f2aff345ddd28e7e82a3a48fce4de0708febe Mon Sep 17 00:00:00 2001
From: Guangzong Chen <chen@ggeta.com>
Date: Thu, 2 May 2024 00:36:53 -0400
Subject: [PATCH] update readme

---
 readme.md | 57 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 57 insertions(+)
 create mode 100644 readme.md

diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..61c7203
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,57 @@
+## Installation
+
+### Rust
+
+install rust from [here](https://www.rust-lang.org/tools/install)
+
+Please use everything as default especially in Windows.
+
+### Git
+
+use `winget install git` in windows
+
+
+## Cargo
+
+Since we have private dependencies, we need to login to use git from system. Add following to `~/.cargo/config`:
+
+```toml
+[net]
+git-fetch-with-cli = true
+
+```
+Make sure you have valid ssh keys in your system and git account.
+
+## Build
+
+```bash
+cargo build --features "stm32u575ci"
+```
+You should replace `stm32u575ci` with your target chip.
+
+Currently we only support very few chips.
+
+## Flash and Run 
+
+You need probe-rs to flash and run the code. Install it with:
+
+```bash
+cargo install probe-rs-cli
+```
+
+Or you can install with `cargo binstall probe-rs"
+
+Refer to [probe-rs](https://probe.rs/) for more information.
+
+Then we can flash and run with:
+
+```bash
+cargo run --features "stm32u575ci"
+```
+
+
+
+
+
+
+