# HG changeset patch
# User Peter Kovacs <kpeter@inf.elte.hu>
# Date 1265974370 -3600
# Node ID 272781e710d9cd5d5159453e6288d86037c1bf5a
# Parent 2ffb7e5556f9abb71c21836034e9d79eae51bf14
Improve README and INSTALL (#342)
diff --git a/INSTALL b/INSTALL
a
|
b
|
|
1 | 1 | Installation Instructions |
2 | 2 | ========================= |
3 | 3 | |
4 | | Since you are reading this I assume you already obtained one of the release |
| 4 | Since you are reading this, I assume you already obtained one of the release |
5 | 5 | tarballs and successfully extracted it. The latest version of LEMON is |
6 | 6 | available at our web page (http://lemon.cs.elte.hu/). |
7 | 7 | |
… |
… |
|
9 | 9 | while the other is based on "cmake". This file contains instructions only for |
10 | 10 | the former one, which is the recommended build environment on Linux, Mac OSX |
11 | 11 | and other unices or if you use Cygwin on Windows. For cmake installation |
12 | | instructions visit http://lemon.cs.elte.hu. |
| 12 | instructions, visit http://lemon.cs.elte.hu. |
13 | 13 | |
14 | | In order to install LEMON from the extracted source tarball you have to |
| 14 | In order to install LEMON from the extracted source tarball, you have to |
15 | 15 | issue the following commands: |
16 | 16 | |
17 | 17 | 1. `cd lemon-x.y.z' |
18 | 18 | |
19 | | This command changes to the directory which was created when you |
| 19 | This command changes to the directory that was created when you |
20 | 20 | extracted the sources. The x.y.z part is a version number. |
21 | 21 | |
22 | 22 | 2. `./configure' |
… |
… |
|
47 | 47 | |
48 | 48 | This command installs the documentation under share/doc/lemon/docs. The |
49 | 49 | generated documentation is included in the tarball. If you want to |
50 | | generate it yourself, then run `make html'. Note that for this you need |
| 50 | generate it yourself, then run `make html'. Note that for this, you need |
51 | 51 | to have the following programs installed: Doxygen, Graphviz, Ghostscript, |
52 | 52 | Latex. |
53 | 53 | |
… |
… |
|
55 | 55 | Configure Options and Variables |
56 | 56 | =============================== |
57 | 57 | |
58 | | In step 2 you can customize the actions of configure by setting variables |
| 58 | In step 2, you can customize the actions of configure by setting variables |
59 | 59 | and passing options to it. This can be done like this: |
60 | 60 | `./configure [OPTION]... [VARIABLE=VALUE]...' |
61 | 61 | |
… |
… |
|
68 | 68 | |
69 | 69 | CXXFLAGS='flags' |
70 | 70 | |
71 | | Pass the 'flags' to the compiler. For example CXXFLAGS='-O3 -march=pentium-m' |
| 71 | Pass the 'flags' to the compiler. For example, CXXFLAGS='-O3 -march=pentium-m' |
72 | 72 | turns on generation of aggressively optimized Pentium-M specific code. |
73 | 73 | |
74 | 74 | --prefix=PREFIX |
75 | 75 | |
76 | | Set the installation prefix to PREFIX. By default it is /usr/local. |
| 76 | Set the installation prefix to PREFIX. By default, it is /usr/local. |
77 | 77 | |
78 | 78 | --enable-tools |
79 | 79 | |
diff --git a/README b/README
a
|
b
|
|
17 | 17 | |
18 | 18 | Copying, distribution and modification conditions and terms. |
19 | 19 | |
| 20 | NEWS |
| 21 | |
| 22 | News and version history. |
| 23 | |
20 | 24 | INSTALL |
21 | 25 | |
22 | 26 | General building and installation instructions. |
… |
… |
|
33 | 37 | |
34 | 38 | Some example programs to make you easier to get familiar with LEMON. |
35 | 39 | |
| 40 | scripts/ |
| 41 | |
| 42 | Scripts that make it easier to develop LEMON. |
| 43 | |
36 | 44 | test/ |
37 | 45 | |
38 | 46 | Programs to check the integrity and correctness of LEMON. |