From 66d76233828d3df3ed834870ac38ef25b4ee2cc4 Mon Sep 17 00:00:00 2001 From: Joel Rosdahl Date: Mon, 25 Jan 2010 22:51:15 +0100 Subject: [PATCH] Add some simple README and INSTALL files --- INSTALL | 57 +++++++++++++++++++++++++++++++++++ Makefile.in | 2 +- README | 85 +++++++++++++++++++++++++++++++++++++++++------------ 3 files changed, 125 insertions(+), 19 deletions(-) create mode 100644 INSTALL diff --git a/INSTALL b/INSTALL new file mode 100644 index 000000000..7e6f8d684 --- /dev/null +++ b/INSTALL @@ -0,0 +1,57 @@ +BUILDING CODE FROM A RELEASE ARCHIVE +==================================== + +PREREQUISITES +------------- + +To build ccache, you need: + + - GNU make (http://www.gnu.org/software/make/) + - A C compiler (for instance GCC) + - zlib (http://www.zlib.net) + + +INSTALLATION +------------ + +To compile and install ccache, run these commands: + + ./configure + make + make install + +You may set the installation directory and other parameters by options to +"./configure". To see them, run "./configure --help". + +There are two ways to use ccache. You can either prefix your compile commands +with "ccache" or you can create a symbolic link between ccache and the names of +your compilers. 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 compiles. + +To install for usage by the first method just copy ccache to somewhere in your +path. + +To install for the second method do something like this: + + cp ccache /usr/local/bin/ + ln -s ccache /usr/local/bin/gcc + ln -s ccache /usr/local/bin/g++ + ln -s ccache /usr/local/bin/cc + ln -s ccache /usr/local/bin/c++ + +This will work as long as /usr/local/bin comes before the path to the compiler +(e.g. gcc, 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 hard links, use symbolic links. Hard links will cause +"interesting" problems. + + +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. + +Run "./autogen.sh" to generate "configure" and "config.h.in". diff --git a/Makefile.in b/Makefile.in index 0da073f34..4fa48e705 100644 --- a/Makefile.in +++ b/Makefile.in @@ -29,7 +29,7 @@ objs = $(sources:.c=.o) dist_files = \ $(sources) $(headers) configure Makefile.in config.h.in ccache.1 \ - test.sh install-sh COPYING README NEWS + test.sh install-sh COPYING INSTALL NEWS README version := $(shell sed -n 's/^\#define CCACHE_VERSION "\(.*\)"/\1/p' \ $(srcdir)/ccache.h) diff --git a/README b/README index daab5e3a7..2bb328975 100644 --- a/README +++ b/README @@ -1,30 +1,79 @@ -This is a re-implementation of "compilercache" in C +CCACHE +====== -The original compilercache scripts were by Erik Thiele -(erikyyy@erikyyy.de) and I would like to thank him for an excellent -piece of work. See http://www.erikyyy.de/compilercache/ for the -original shell scripts. +ABOUT +----- -I wrote ccache because I wanted to get a bit more speed out of a -compiler cache and I wanted to remove some of the limitations of the -shell-script version. +ccache is a compiler cache. It speeds up recompilation of C/C++ code by caching +previous compiles and detecting when the same compile is being done again. The +main focus is to handle the GNU C/C++ compiler (GCC), but it may also work with +compilers that mimic GCC good enough. + +Please see the manual page and documentation at http://ccache.samba.org for +more information. -Please see the manual page and documentation at -http://ccache.samba.org/ INSTALLATION +----------- + +See the INSTALL file. + + +WEB SITE +-------- + +The main ccache web site is here: + + http://ccache.samba.org + + +MAILING LIST ------------ -Please run: +There is a mailing list for discussing usage and development of ccache: + + http://lists.samba.org/mailman/listinfo/ccache/ - ./configure - make - make install +Anyone is welcome to join. -then read the ccache manual page +BUG REPORTS ----------- -Andrew Tridgell -http://samba.org/~tridge/ -bugs@ccache.samba.org +To submit a bug report or to search for existing reports, please visit this web +page: + + http://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 git://git.samba.org/ccache.git + +You can also browse the repository: + + http://gitweb.samba.org/?p=ccache.git + + +HISTORY +------- + +ccache was originally written by Andrew Tridgell and is currently maintained by +Joel Rosdahl. ccache started out as a re-implementation of Erik Thiele's +"compilercache" (see http://www.erikyyy.de/compilercache/) in C. + +See also the NEWS file. + + +COPYRIGHT +--------- + +ccache may be used, modified and redistributed only under the terms of the GNU +General Public License, found in the file COPYING in this distribution, or on +this web page: + + http://www.fsf.org/licenses/gpl.html -- 2.47.3