summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-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..9ada459
--- /dev/null
+++ b/README.md
@@ -0,0 +1,16 @@
+## int2bin
+
+int2bin is a simple program which converts integers passed as arguments into a binary representation. int2bin does support negative integers, and represents them using 2s compliment notation. For documentation run
+
+```
+$ int2bin --help
+```
+
+### Compiling and Installing
+
+The program's only dependencies are make and gcc (although any C compiler should work). To compile and install int2bin:
+
+```
+$ make
+# make install
+```