Merge pull request #133 from haneefmubarak/patch-1

Update and rename README to README.md

2 files changed, 63 insertions, 45 deletions

diff --git a/README b/README
deleted file mode 100644
index 8c7301f..0000000
--- a/README
+++ /dev/null
@@ -1,45 +0,0 @@
-Building on Unix with git, gcc and autotools
-
-Home page for json-c:
-  https://github.com/json-c/json-c/wiki
-
-  Caution: do NOT use sources from svn.metaparadigm.com, they are old.
-
-Prerequisites:
-	gcc (or another C compiler)
-	libtool
-
-	If you're not using a release tarball, you'll also need:
-	autoconf (autoreconf)
-	automake
-	Make sure you have a complete libtool install, including libtoolize
-
-Github repo for json-c:
-  https://github.com/json-c/json-c
-
-    $ git clone https://github.com/json-c/json-c.git
-    $ cd json-c
-    $ sh autogen.sh
-
-Then 
-
-    $ ./configure
-    $ make
-    $ make install
-
-To build and run the test programs run 
-
-    $ make check
-
-Linking to libjson-c
-
-If your system has pkgconfig then you can just add this to your makefile
-
-CFLAGS += $(shell pkg-config --cflags json-c)
-LDFLAGS += $(shell pkg-config --libs json-c)
-
-Without pkgconfig, you would do something like this:
-
-JSON_C_DIR=/path/to/json_c/install
-CFLAGS += -I$(JSON_C_DIR)/include/json-c
-LDFLAGS+= -L$(JSON_C_DIR)/lib -ljson-c
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e101114
--- /dev/null
+++ b/README.md
@@ -0,0 +1,63 @@
+`json-c`
+========
+
+Building on *nix with `git`, `gcc` and `autotools`
+--------------------------------------------------
+
+Home page for json-c: https://github.com/json-c/json-c/wiki
+
+Caution: do **NOT** use sources from svn.metaparadigm.com,
+they are old.
+
+Prerequisites:
+
+ - `gcc`, `clang`, or another C compiler
+ - `libtool`
+
+If you're not using a release tarball, you'll also need:
+
+ - `autoconf` (`autoreconf`)
+ - `automake`
+
+Make sure you have a complete `libtool` install, including `libtoolize`.
+
+`json-c` GitHub repo: https://github.com/json-c/json-c
+
+```bash
+$ git clone https://github.com/json-c/json-c.git
+$ cd json-c
+$ sh autogen.sh
+```
+
+followed by
+
+```bash
+$ ./configure
+$ make
+$ make install
+```
+
+To build and run the test programs:
+
+```bash
+$ make check
+```
+
+Linking to `libjson-c`
+----------------------
+
+If your system has `pkgconfig`,
+then you can just add this to your `makefile`:
+
+```make
+CFLAGS += $(shell pkg-config --cflags json-c)
+LDFLAGS += $(shell pkg-config --libs json-c)
+```
+
+Without `pkgconfig`, you would do something like this:
+
+```make
+JSON_C_DIR=/path/to/json_c/install
+CFLAGS += -I$(JSON_C_DIR)/include/json-c
+LDFLAGS+= -L$(JSON_C_DIR)/lib -ljson-c
+```