feat: use flip-link by default

Signed-off-by: Haobo Gu <[email protected]>

.cargo/config.toml

@@ -8,6 +8,7 @@ linker = "ldproxy"
 rustflags = [ "--cfg",  "espidf_time64"] # Extending time_t for ESP IDF 5: https://github.com/esp-rs/rust/issues/110
 {% else -%}
 [target.'cfg(all(target_arch = "arm", target_os = "none"))']
+linker = "flip-link"
 {% endif -%}
 {% if microcontroller_family == "rp2040" -%}
 runner = "probe-rs run --chip rp2040"

Makefile.toml

@@ -1,14 +1,17 @@
 [tasks.install-llvm-tools]
 install_crate = { rustup_component_name = "llvm-tools" }
 
+[tasks.flip-link]
+install_crate = { crate_name = "flip-link", binary = "flip-link", test_arg = ["flip-link", "-h"] }
+
 [tasks.objcopy]
 install_crate = { crate_name = "cargo-binutils", binary = "cargo", test_arg = [
     "objcopy",
     "--help",
 ] }
 command = "cargo"
 args = ["objcopy", "--release", "--", "-O", "ihex", "rmk.hex"]
-dependencies = ["install-llvm-tools"]
+dependencies = ["install-llvm-tools", "flip-link"]
 
 [tasks.uf2]
 command = "python"

Makefile_split.toml

@@ -1,6 +1,9 @@
 [tasks.install-llvm-tools]
 install_crate = { rustup_component_name = "llvm-tools" }
 
+[tasks.flip-link]
+install_crate = { crate_name = "flip-link", binary = "flip-link", test_arg = ["flip-link", "-h"] }
+
 [tasks.objcopy-central]
 install_crate = { crate_name = "cargo-binutils", binary = "cargo", test_arg = [
     "objcopy",
@@ -17,7 +20,7 @@ args = [
     "ihex",
     "rmk-central.hex",
 ]
-dependencies = ["install-llvm-tools"]
+dependencies = ["install-llvm-tools", "flip-link"]
 
 [tasks.objcopy-peripheral]
 install_crate = { crate_name = "cargo-binutils", binary = "cargo", test_arg = [

README.md

@@ -4,10 +4,10 @@ Template for initializing a [RMK](https://github.com/HaoboGu/rmk) keyboard firmw
 
 ## Usage
 
-1. Install `cargo generate`
+1. Install `cargo generate` and `flip-link`
 
     ```shell
-    cargo install cargo-generate
+    cargo install cargo-generate flip-link
     ```
 
 2. Create your project using the template
@@ -20,7 +20,11 @@ Template for initializing a [RMK](https://github.com/HaoboGu/rmk) keyboard firmw
 4. (optional) Install [`probe-rs`](https://github.com/probe-rs/probe-rs) for flashing and debugging
 
    ```shell
-   cargo install probe-rs --features cli
+   # https://probe.rs/docs/getting-started/installation/
+   # Linux or macOS
+   curl --proto '=https' --tlsv1.2 -LsSf https://github.com/probe-rs/probe-rs/releases/latest/download/probe-rs-tools-installer.sh | sh
+   # Windows
+   irm https://github.com/probe-rs/probe-rs/releases/latest/download/probe-rs-tools-installer.ps1 | iex
    ```
 
 5. (optional) Build and flash