summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorlshprung <lshprung@yahoo.com>2022-05-24 21:00:10 -0700
committerlshprung <lshprung@yahoo.com>2022-05-24 21:04:00 -0700
commit8cd5a7a5c57978b4b904164e0be3305b19e1199e (patch)
tree35ad4e49d99d622b84f5a6a0ac693b4db3b6a649
parenta2a3756b849504432f5d12de84e3dd9ba7ef8cda (diff)
Created README
-rw-r--r--.gitignore1
-rw-r--r--README.md16
2 files changed, 17 insertions, 0 deletions
diff --git a/.gitignore b/.gitignore
index fced1fb..f1607d1 100644
--- a/.gitignore
+++ b/.gitignore
@@ -2,5 +2,6 @@
!int2bin.c
!Makefile
+!README.md
!.gitignore
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
+```