initial commit

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..dda5944
--- /dev/null
+++ b/README.md
@@ -0,0 +1,24 @@
+# RescueSys
+
+Linux based image for backup and restore entire PC disks resp. SSDs.
+
+## Getting started
+
+These instructions will get you a copy of the project up and running on your local
+machine.
+
+### Installing
+
+Get the project using git:
+
+```
+git clone https://binomiant.duckdns.org/MpqU9XX8/rescuesys.git
+
+To build an image for an USB stick run the build script:
+
+```
+./build -a
+```
+
+Note that you have to shutdown the VM before the image is created. Flash the image to your USB stick and boot the machine from the stick.
+