Merge pull request #10 from ThibF/thibf/build_install_doc

README.md: add building and installation section
arighi · May 24, 2024 · 9f75983 · 9f75983
2 parents 956df71 + 9994df4
commit 9f75983
Showing 1 changed file with 17 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -54,6 +54,23 @@ user	0m0.736s
 sys	0m0.795s
 ```
 
+# Building
+
+Static building is necessary as this binary is going to be executed
+before the file system is up and running.
+
+```
+RUSTFLAGS='-C target-feature=+crt-static' cargo build -r
+```
+
+# Local installation
+
+Put the binary into virtme/guest/bin/.
+e.g. when used as a submodule:
+```
+cp target/release/virtme-ng-init ../virtme/guest/bin
+```
+
 # Credits
 
 Author: Andrea Righi <[email protected]>