aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNathan Reiner <nathan@nathanreiner.xyz>2023-03-27 21:31:27 +0200
committerNathan Reiner <nathan@nathanreiner.xyz>2023-03-27 21:31:27 +0200
commit7beb31f48515cbc3eb0e91b09c2faa66ca286b15 (patch)
treeb6f1efe4212612f6ad75aad465c8a18769c55fb1
parentac015d36e4ec4dafe9a0f481ed0fb8c6d6ee3f84 (diff)
add README
-rw-r--r--README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6f39d5a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,16 @@
+# SecKey
+
+This project is intended to be used when your system
+uses a usb-drive to decrypt your system's root drive.
+
+If you want that if you plug out the stick your system shuts down
+you are at the right place here.
+
+## Install
+
+Edit the `config.mk` and insert the UUID of your usb-drive.
+Then type:
+
+```sh
+sudo make install
+```