From 23620b827cf43f893fac6ddd67277d835c3fdc1d Mon Sep 17 00:00:00 2001 From: Haneef Mubarak Date: Sat, 12 Apr 2014 00:36:08 -0700 Subject: [PATCH 1/2] Update and rename README to README.md Markdownify + fix a few errors here and there --- README | 45 ---------------------------------------- README.md | 62 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 62 insertions(+), 45 deletions(-) delete mode 100644 README create mode 100644 README.md 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..89ed699 --- /dev/null +++ b/README.md @@ -0,0 +1,62 @@ +json-c +====== + +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`, `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. + +Github repo for json-c: 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 +``` From 7870978c2e6da5fda7ffeb4e7ba8ee5aae9d8aab Mon Sep 17 00:00:00 2001 From: Haneef Mubarak Date: Sat, 12 Apr 2014 00:40:05 -0700 Subject: [PATCH 2/2] Update README.md - code blocks - slight text changes (rewording) - pretty printing --- README.md | 27 ++++++++++++++------------- 1 file 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