summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHaneef Mubarak <haneefmubarak@users.noreply.github.com>2014-04-12 00:40:05 -0700
committerHaneef Mubarak <haneefmubarak@users.noreply.github.com>2014-04-12 00:40:05 -0700
commit7870978c2e6da5fda7ffeb4e7ba8ee5aae9d8aab (patch)
treed74401a6e7e1c8e10a510d408e3de183d5140920
parent23620b827cf43f893fac6ddd67277d835c3fdc1d (diff)
Update README.md
- code blocks - slight text changes (rewording) - pretty printing
-rw-r--r--README.md27
1 files changed, 14 insertions, 13 deletions
diff --git a/README.md b/README.md
index 89ed699..e101114 100644
--- 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