]> git.ipfire.org Git - thirdparty/json-c.git/commitdiff
Update README.md 133/head
authorHaneef Mubarak <haneefmubarak@users.noreply.github.com>
Sat, 12 Apr 2014 07:40:05 +0000 (00:40 -0700)
committerHaneef Mubarak <haneefmubarak@users.noreply.github.com>
Sat, 12 Apr 2014 07:40:05 +0000 (00:40 -0700)
 - code blocks
 - slight text changes (rewording)
 - pretty printing

README.md

index 89ed6996233b7f2928ede0fc2c4a525ad12040ec..e1011141e3986a09809de8c34eecbedd56547a73 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,12 +1,13 @@
-json-c
-======
+`json-c`
+========
 
-Building on Unix with git, gcc and autotools
---------------------------------------------
+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.
+Caution: do **NOT** use sources from svn.metaparadigm.com,
+they are old.
 
 Prerequisites:
 
@@ -18,9 +19,9 @@ 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.
+Make sure you have a complete `libtool` install, including `libtoolize`.
 
-Github repo for json-c: https://github.com/json-c/json-c
+`json-c` GitHub repo: https://github.com/json-c/json-c
 
 ```bash
 $ git clone https://github.com/json-c/json-c.git
@@ -39,21 +40,21 @@ $ make install
 To build and run the test programs:
 
 ```bash
-    $ make check
+$ make check
 ```
 
-Linking to libjson-c
---------------------
+Linking to `libjson-c`
+----------------------
 
-If your system has pkgconfig,
-then you can just add this to your makefile:
+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:
+Without `pkgconfig`, you would do something like this:
 
 ```make
 JSON_C_DIR=/path/to/json_c/install