Updated the README file with some contributor tips.
[basket4.git] / INSTALL
blob99ef236bf5ad699fd5d537ee43d3926cdb852047
1     /====================================\
2     | Quick Installation with the Wizard |
3     \====================================/
5 Quick Instructions
6 ==================
8     The installation can easily be performed by launching the
9 ./installer script in a terminal and by following the instructions.
10 Theire is nothing else to do.
12 More Information
13 ================
15     In Konqueror, after having un-compressed the .tar.gz file containing
16 BasKet Note Pads, choose `Open a terminal' while in the un-compressed
17 folder (the same where you can read this file).
18 Then, type "./installer" (without the quotes) and press Enter.
19 You just have to follow the wizard.
21     The scrit is there just to simplify your life.
22 If it does not work or you if want more control (experienced users) on
23 the configure process, please read the following paragraphs.
25     /===================================\
26     | Standard UNIX Way of Installation |
27     \===================================/
29 Basic Installation
30 ==================
32    These are generic installation instructions.
34    The `configure' shell script attempts to guess correct values for
35 various system-dependent variables used during compilation.  It uses
36 those values to create a `Makefile' in each directory of the package.
37 It may also create one or more `.h' files containing system-dependent
38 definitions.  Finally, it creates a shell script `config.status' that
39 you can run in the future to recreate the current configuration, a file
40 `config.cache' that saves the results of its tests to speed up
41 reconfiguring, and a file `config.log' containing compiler output
42 (useful mainly for debugging `configure').
44    If you need to do unusual things to compile the package, please try
45 to figure out how `configure' could check whether to do them, and mail
46 diffs or instructions to the address given in the `README' so they can
47 be considered for the next release.  If at some point `config.cache'
48 contains results you don't want to keep, you may remove or edit it.
50    The file `configure.in' is used to create `configure' by a program
51 called `autoconf'.  You only need `configure.in' if you want to change
52 it or regenerate `configure' using a newer version of `autoconf'.
54 The simplest way to compile this package is:
56   1. `cd' to the directory containing the package's source code and type
57      `./configure' to configure the package for your system.  If you're
58      using `csh' on an old version of System V, you might need to type
59      `sh ./configure' instead to prevent `csh' from trying to execute
60      `configure' itself.
62      Running `configure' takes a while.  While running, it prints some
63      messages telling which features it is checking for.
65   2. Type `make' to compile the package.
67   3. Type `make install' to install the programs and any data files and
68      documentation.
70   4. You can remove the program binaries and object files from the
71      source code directory by typing `make clean'.
73 Compilers and Options
74 =====================
76    Some systems require unusual options for compilation or linking that
77 the `configure' script does not know about.  You can give `configure'
78 initial values for variables by setting them in the environment.  Using
79 a Bourne-compatible shell, you can do that on the command line like
80 this:
81      CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure
83 Alternatively, on systems that have the `env' program, you can do it like this:
84      env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure
86 Compiling For Multiple Architectures
87 ====================================
89    You can compile the package for more than one kind of computer at the
90 same time, by placing the object files for each architecture in their
91 own directory.  To do this, you must use a version of `make' that
92 supports the `VPATH' variable, such as GNU `make'.  `cd' to the
93 directory where you want the object files and executables to go and run
94 the `configure' script.  `configure' automatically checks for the
95 source code in the directory that `configure' is in and in `..'.
97    If you have to use a `make' that does not supports the `VPATH'
98 variable, you have to compile the package for one architecture at a time
99 in the source code directory.  After you have installed the package for
100 one architecture, use `make distclean' before reconfiguring for another
101 architecture.
103 Installation Names
104 ==================
106    By default, `make install' will install the package's files in
107 `/usr/local/bin', `/usr/local/man', etc.  You can specify an
108 installation prefix other than `/usr/local' by giving `configure' the
109 option `--prefix=PATH'.
111    You can specify separate installation prefixes for
112 architecture-specific files and architecture-independent files.  If you
113 give `configure' the option `--exec-prefix=PATH', the package will use
114 PATH as the prefix for installing programs and libraries.
115 Documentation and other data files will still use the regular prefix.
117    If the package supports it, you can cause programs to be installed
118 with an extra prefix or suffix on their names by giving `configure' the
119 option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
121 Optional Features
122 =================
124    Some packages pay attention to `--enable-FEATURE' options to
125 `configure', where FEATURE indicates an optional part of the package.
126 They may also pay attention to `--with-PACKAGE' options, where PACKAGE
127 is something like `gnu-as' or `x' (for the X Window System).  The
128 `README' should mention any `--enable-' and `--with-' options that the
129 package recognizes.
131    For packages that use the X Window System, `configure' can usually
132 find the X include and library files automatically, but if it doesn't,
133 you can use the `configure' options `--x-includes=DIR' and
134 `--x-libraries=DIR' to specify their locations.
136 Specifying the System Type
137 ==========================
139    There may be some features `configure' can not figure out
140 automatically, but needs to determine by the type of host the package
141 will run on.  Usually `configure' can figure that out, but if it prints
142 a message saying it can not guess the host type, give it the
143 `--host=TYPE' option.  TYPE can either be a short name for the system
144 type, such as `sun4', or a canonical name with three fields:
145      CPU-COMPANY-SYSTEM
147 See the file `config.sub' for the possible values of each field.  If
148 `config.sub' isn't included in this package, then this package doesn't
149 need to know the host type.
151    If you are building compiler tools for cross-compiling, you can also
152 use the `--target=TYPE' option to select the type of system they will
153 produce code for and the `--build=TYPE' option to select the type of
154 system on which you are compiling the package.
156 Sharing Defaults
157 ================
159    If you want to set default values for `configure' scripts to share,
160 you can create a site shell script called `config.site' that gives
161 default values for variables like `CC', `cache_file', and `prefix'.
162 `configure' looks for `PREFIX/share/config.site' if it exists, then
163 `PREFIX/etc/config.site' if it exists.  Or, you can set the
164 `CONFIG_SITE' environment variable to the location of the site script.
165 A warning: not all `configure' scripts look for a site script.
167 Operation Controls
168 ==================
170    `configure' recognizes the following options to control how it
171 operates.
173 `--cache-file=FILE'
174      Use and save the results of the tests in FILE instead of
175      `./config.cache'.  Set FILE to `/dev/null' to disable caching, for
176      debugging `configure'.
178 `--help'
179      Print a summary of the options to `configure', and exit.
181 `--quiet'
182 `--silent'
183 `-q'
184      Do not print messages saying which checks are being made.
186 `--srcdir=DIR'
187      Look for the package's source code in directory DIR.  Usually
188      `configure' can determine that directory automatically.
190 `--version'
191      Print the version of Autoconf used to generate the `configure'
192      script, and exit.
194 `configure' also accepts some other, not widely useful, options.