Convert README and INSTALL to markdown

diff --git a/INSTALL.txt b/INSTALL.md
similarity index 61%
rename from INSTALL.txt
rename to INSTALL.md
index f77cbe6764736d6db5cfeafeddf94889a5881637..de7d5aadb903de762feeafc09e5e8e45e956881a 100644 (file)
--- a/INSTALL.txt
+++ b/INSTALL.md
@@ -5,8 +5,7 @@ ccache installation
 Building code from a release archive
 ------------------------------------
 
-Prerequisites
-~~~~~~~~~~~~~
+### Prerequisites
 
 To build ccache, you need:
 
@@ -14,12 +13,11 @@ To build ccache, you need:
 
 It is also recommended that you have:
 
-- zlib <http://www.zlib.net> (if you don't have zlib installed, ccache will
+- [zlib](http://www.zlib.net) (if you don't have zlib installed, ccache will
   use a bundled copy)
 
 
-Installation
-~~~~~~~~~~~~
+### Installation
 
 To compile and install ccache, run these commands:
 
@@ -28,16 +26,16 @@ To compile and install ccache, run these commands:
     make install
 
 You may set the installation directory and other parameters by options to
-``./configure''. To see them, run ``./configure --help''.
+`./configure`. To see them, run `./configure --help`.
 
 There are two ways to use ccache. You can either prefix your compilation
-commands with ``ccache'' or you can create a symbolic link (named as your
+commands with `ccache` or you can create a symbolic link (named as your
 compiler) to ccache. The first method is most convenient if you just want to
 try out ccache or wish to use it for some specific projects. The second method
 is most useful for when you wish to use ccache for all your compilations.
 
 To install for usage by the first method just copy ccache to somewhere in your
-path.
+path.s
 
 To install for the second method, do something like this:
 
@@ -47,12 +45,12 @@ To install for the second method, do something like this:
     ln -s ccache /usr/local/bin/cc
     ln -s ccache /usr/local/bin/c++
 
-And so forth. This will work as long as ``/usr/local/bin'' comes before the
-path to the compiler (which is usually in ``/usr/bin''). After installing you
-may wish to run ``which gcc'' to make sure that the correct link is being used.
+And so forth. This will work as long as `/usr/local/bin` comes before the path
+to the compiler (which is usually in `/usr/bin`). After installing you may wish
+to run `which gcc` to make sure that the correct link is being used.
 
 NOTE: Do not use a hard link, use a symbolic link. A hard link will cause
-``interesting'' problems.
+"interesting" problems.
 
 
 Building code from the source code repository
@@ -60,14 +58,14 @@ Building code from the source code repository
 
 In addition to the prerequisites mentioned above, you also need:
 
-- AsciiDoc (http://www.methods.co.nz/asciidoc/) to build the documentation.
-- Autoconf (http://www.gnu.org/software/autoconf/)
-- gperf (http://www.gnu.org/software/gperf/)
-- xsltproc (http://xmlsoft.org/XSLT/xsltproc2.html)
+- [AsciiDoc](http://www.methods.co.nz/asciidoc/) to build the documentation.
+- [Autoconf](http://www.gnu.org/software/autoconf/)
+- [gperf](http://www.gnu.org/software/gperf/)
+- [xsltproc](http://xmlsoft.org/XSLT/xsltproc2.html)
 
 To debug and run the performance test suite you'll also need:
 
-- Python (http://www.python.org/)
+- [Python](http://www.python.org)
 
-Run "./autogen.sh" and then follow the steps mentioned under "Installation"
+Run `./autogen.sh` and then follow the steps mentioned under "Installation"
 above.

diff --git a/README.txt b/README.md
similarity index 52%
rename from README.txt
rename to README.md
index cb1d7505e1ac691218d87959f21c6064f2a46bb2..cbb985a718938ed0d4d76591dcc9c01ca1a7042a 100644 (file)
--- a/README.txt
+++ b/README.md
@@ -1,6 +1,7 @@
-ccache README
-=============
+ccache
+======
 
+[![Build Status](https://travis-ci.org/ccache/ccache.svg?branch=master)](https://travis-ci.org/ccache/ccache)
 
 About
 -----
@@ -9,20 +10,17 @@ ccache is a compiler cache. It speeds up recompilation by caching the result of
 previous compilations and detecting when the same compilation is being done
 again. Supported languages are C, C++, Objective-C and Objective-C++.
 
-Please see the manual page and documentation at https://ccache.samba.org for
-more information.
-
 
 Documentation
 -------------
 
-See the ccache(1) man page. It's also available as MANUAL.{txt,html}.
+See the https://ccache.samba.org.
 
 
 Installation
 ------------
 
-See INSTALL.{txt.html}.
+See [INSTALL.md](INSTALL.md).
 
 
 Web site
@@ -30,7 +28,7 @@ Web site
 
 The main ccache web site is here:
 
-    https://ccache.samba.org
+https://ccache.samba.org
 
 
 Mailing list
@@ -38,7 +36,7 @@ Mailing list
 
 There is a mailing list for discussing usage and development of ccache:
 
-    https://lists.samba.org/mailman/listinfo/ccache/
+https://lists.samba.org/mailman/listinfo/ccache/
 
 Anyone is welcome to join.
 
@@ -49,20 +47,7 @@ Bug reports
 To submit a bug report or to search for existing reports, please visit this web
 page:
 
-    https://ccache.samba.org/bugs.html
-
-
-Source code repository
-----------------------
-
-To get the very latest version of ccache directly from the source code
-repository, use git:
-
-    git clone https://github.com/ccache/ccache.git
-
-You can also browse the repository:
-
-    https://github.com/ccache/ccache
+https://ccache.samba.org/bugs.html
 
 
 History
@@ -70,12 +55,12 @@ History
 
 ccache was originally written by Andrew Tridgell and is currently developed and
 maintained by Joel Rosdahl. ccache started out as a reimplementation of Erik
-Thiele's ``compilercache'' (see http://www.erikyyy.de/compilercache/) in C.
+Thiele's "compilercache" (see http://www.erikyyy.de/compilercache/) in C.
 
-See also NEWS.{txt,html}.
+See also https://ccache.samba.org/news.html.
 
 
 License and copyright
 ---------------------
 
-See LICENSE.{txt,html} and AUTHORS.{txt,html}.
+See https://ccache.samba.org/license.html.

diff --git a/dev.mk.in b/dev.mk.in
index a6176f166090de6a89203e7178e05908a11ad39d..c440034d9a4bbeb75d2ebf395cf867e82100795d 100644 (file)
--- a/dev.mk.in
+++ b/dev.mk.in
@@ -25,9 +25,7 @@ ifneq ($(shell uname), Darwin)
     dist_archives += ccache-$(version).tar.xz
 endif
 
-generated_docs = \
-    ccache.1 AUTHORS.html INSTALL.html LICENSE.html MANUAL.html NEWS.html \
-    README.html
+generated_docs = ccache.1 AUTHORS.html LICENSE.html MANUAL.html NEWS.html
 built_dist_files = $(generated_docs)
 
 headers = \
@@ -61,12 +59,12 @@ source_dist_files = \
     AUTHORS.txt \
     GPL-3.0.txt \
     HACKING.txt \
-    INSTALL.txt \
+    INSTALL.md \
     LICENSE.txt \
     MANUAL.txt \
     Makefile.in \
     NEWS.txt \
-    README.txt \
+    README.md \
     autogen.sh \
     config.guess \
     config.h.in \