From 8cd5a7a5c57978b4b904164e0be3305b19e1199e Mon Sep 17 00:00:00 2001 From: lshprung Date: Tue, 24 May 2022 21:00:10 -0700 Subject: Created README --- .gitignore | 1 + README.md | 16 ++++++++++++++++ 2 files changed, 17 insertions(+) create mode 100644 README.md 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 +``` -- cgit