initial commit

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..3defa2e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,25 @@
+# shgen
+
+Console based shell script generator using ncurses/CDK.
+
+## 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/shgen.git
+```
+
+To build a debian package go to deb directory and run the build script:
+
+```
+cd shgen.git/deb
+./make_deb.sh
+```
+
+Install the debian package via `dpkg -i` or a package manager of your flavour and then run the executable `shgen` in a terminal.