add build instructions

R2Northstar · Oct 15, 2023 · 8ac3690 · 8ac3690
1 parent ebd1404
commit 8ac3690
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,3 +1,9 @@
 # NorthstarDiscordRPC
 
 Plugin to integrate Northstar with Discord's SDK to enable [rich presence](https://discord.com/rich-presence).
+
+# Building
+
+The Northstar RPC plugin uses [cargo](https://doc.rust-lang.org/cargo/index.html) to download dependencies and build code
+
+Run `cargo build --release` in the root directory of the plugin. The output will be found in `target/release`.