From: Joshua D. Boyd <jdboyd@jdboyd.net>
Date: Thu, 31 Mar 2016 03:48:06 +0000 (-0400)
Subject: Convert README to README.md.
X-Git-Tag: 0.11.0~29^2~1
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=1d361e30b7ceae432d79d1d6fd13dc52d48b5424;p=check

Convert README to README.md.

Now README is generated from README.md for packaging purposes.

Also add travis and appveyor status icons.

This addresses issue #32.
---

diff --git a/Makefile.am b/Makefile.am
index 4857775..c031a35 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -38,6 +38,9 @@ DISTCLEANFILES = check_stdint.h
 
 ACLOCAL_AMFLAGS = -I m4
 
+README:
+	fgrep -v "Build Status]" README.md > $@
+
 doc/check_html:
 	$(MAKE) -C doc check_html
 
diff --git a/README b/README.md
similarity index 53%
rename from README
rename to README.md
index f7c36d0..27259f3 100644
--- a/README
+++ b/README.md
@@ -1,5 +1,8 @@
-About Check
------------
+# About Check
+
+[![Travis Build Status](https://travis-ci.org/libcheck/check.svg?branch=master)](https://travis-ci.org/libcheck/check)
+[![Appveyor Build Status](https://ci.appveyor.com/api/projects/status/github/libcheck/check?svg=true)](https://ci.appveyor.com/project/libcheck/check/branch/master)
+
 
 Check is a unit testing framework for C. It features a simple interface
 for defining unit tests, putting little in the way of the
@@ -9,26 +12,28 @@ faults or other signals. The output from unit tests can be used within
 source code editors and IDEs.
 
 See https://libcheck.github.io/check for more information, including a
-tutorial.  The tutorial is also available as `info check'.
+tutorial.  The tutorial is also available as `info check`.
 
-Installation
-------------
+# Installation
 
 Check has the following dependencies:
 
-  automake-1.9.6 (1.11.3 on OS X if you are using /usr/bin/ar)
-  autoconf-2.59
-  libtool-1.5.22
-  pkg-config-0.20
-  texinfo-4.7 (for documentation)
-  tetex-bin (or any texinfo-compatible TeX installation, for documentation)
-  POSIX sed
+* automake-1.9.6 (1.11.3 on OS X if you are using /usr/bin/ar)
+* autoconf-2.59
+* libtool-1.5.22
+* pkg-config-0.20
+* texinfo-4.7 (for documentation)
+* tetex-bin (or any texinfo-compatible TeX installation, for documentation)
+* POSIX sed
 
 The versions specified may be higher than those actually needed.
 
-First, do
+## autoconf
 
-$ autoreconf --install
+    $ autoreconf --install
+    $ ./configure
+    $ make
+    $ make check
 
 in this directory to set everything up.  autoreconf calls all of the
 necessary tools for you, like autoconf, automake, autoheader, etc.  If
@@ -36,12 +41,17 @@ you ever change something during development, run autoreconf again
 (without --install), and it will perform the minimum set of actions
 necessary.
 
-Then, read the directions in INSTALL if you need more information.
+## cmake
+
+    $ mkdir build
+    $ cd build
+    $ cmake ../
+    $ make
+    $ CTEST_OUTPUT_ON_FAILURE=1 make test
 
-Linking against Check
----------------------
+# Linking against Check
 
 Check uses variadic macros in check.h, and the strict C90 options for
 gcc will complain about this.  In gcc 4.0 and above you can turn this
-off explicitly with -Wno-variadic-macros.  In a future API it would be
+off explicitly with `-Wno-variadic-macros`.  In a future API it would be
 nice to eliminate these macros.