Add build instructions to readme

2023-04-05 15:19:32 +02:00 · 2023-04-05 15:19:32 +02:00 · ce0a003b67
parent 7c48e34d60
commit ce0a003b67
1 changed files with 13 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -72,4 +72,17 @@ in {
    '';
  };
 }
+```
+
+## Building from source
+Clone this repository, then run:
+```sh
+cargo build --release
+```
+You will need Rust 1.65 or newer.  
+The output binary will be in `target/release/url-eater`  
+
+Alternatively,
+```sh
+nix build github:AgathaSorceress/url-eater
 ```