summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJoel Rosdahl <joel@rosdahl.net>2016-07-16 09:55:18 +0200
committerJoel Rosdahl <joel@rosdahl.net>2016-07-16 09:55:18 +0200
commit5d33f1512798dfc2feb5c7f89f56d471ced70c48 (patch)
treecd151f613500951c8e4704e1a93296a19d863fba /README.md
parent2d006aeb72e62e5ccb78cd0a2c7be77748c8546e (diff)
downloadccache-5d33f1512798dfc2feb5c7f89f56d471ced70c48.tar.gz
Convert README and INSTALL to markdown
Diffstat (limited to 'README.md')
-rw-r--r--README.md66
1 files changed, 66 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 00000000..cbb985a7
--- /dev/null
+++ b/README.md
@@ -0,0 +1,66 @@
+ccache
+======
+
+[![Build Status](https://travis-ci.org/ccache/ccache.svg?branch=master)](https://travis-ci.org/ccache/ccache)
+
+About
+-----
+
+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++.
+
+
+Documentation
+-------------
+
+See the https://ccache.samba.org.
+
+
+Installation
+------------
+
+See [INSTALL.md](INSTALL.md).
+
+
+Web site
+--------
+
+The main ccache web site is here:
+
+https://ccache.samba.org
+
+
+Mailing list
+------------
+
+There is a mailing list for discussing usage and development of ccache:
+
+https://lists.samba.org/mailman/listinfo/ccache/
+
+Anyone is welcome to join.
+
+
+Bug reports
+-----------
+
+To submit a bug report or to search for existing reports, please visit this web
+page:
+
+https://ccache.samba.org/bugs.html
+
+
+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.
+
+See also https://ccache.samba.org/news.html.
+
+
+License and copyright
+---------------------
+
+See https://ccache.samba.org/license.html.