Fossil SCM

Add a "Contributing" link to the homepage. Update the build documentation.

drh 2011-06-18 18:06 trunk
Commit 2d50893dd8653fa68fe29e1f6c7c5b473549f21b
+7 -2
--- BUILD.txt
+++ BUILD.txt
@@ -3,13 +3,18 @@
33
use the Makefile. To do a complete build on unix, just type:
44
55
make
66
77
On a windows box, use one of the Makefiles in the win/ subdirectory,
8
-according to your compiler and environment. For example:
8
+according to your compiler and environment. If you have GCC and MSYS
9
+installed on your system, the consider:
10
+
11
+ make -f win/Makefile.mingw
12
+
13
+If you have VC++ installed on your system, then consider:
914
10
- make -f win/Makefile.w32
15
+ cd win; nmake /f Makefile.msc
1116
1217
If you have trouble, or you want to do something fancy, just look at
1318
top level makefile. There are 6 configuration options that are all well
1419
commented. Instead of editing the Makefile, consider copying the Makefile
1520
to an alternative name such as "GNUMakefile", "BSDMakefile", or "makefile"
1621
--- BUILD.txt
+++ BUILD.txt
@@ -3,13 +3,18 @@
3 use the Makefile. To do a complete build on unix, just type:
4
5 make
6
7 On a windows box, use one of the Makefiles in the win/ subdirectory,
8 according to your compiler and environment. For example:
 
 
 
 
 
9
10 make -f win/Makefile.w32
11
12 If you have trouble, or you want to do something fancy, just look at
13 top level makefile. There are 6 configuration options that are all well
14 commented. Instead of editing the Makefile, consider copying the Makefile
15 to an alternative name such as "GNUMakefile", "BSDMakefile", or "makefile"
16
--- BUILD.txt
+++ BUILD.txt
@@ -3,13 +3,18 @@
3 use the Makefile. To do a complete build on unix, just type:
4
5 make
6
7 On a windows box, use one of the Makefiles in the win/ subdirectory,
8 according to your compiler and environment. If you have GCC and MSYS
9 installed on your system, the consider:
10
11 make -f win/Makefile.mingw
12
13 If you have VC++ installed on your system, then consider:
14
15 cd win; nmake /f Makefile.msc
16
17 If you have trouble, or you want to do something fancy, just look at
18 top level makefile. There are 6 configuration options that are all well
19 commented. Instead of editing the Makefile, consider copying the Makefile
20 to an alternative name such as "GNUMakefile", "BSDMakefile", or "makefile"
21
+24 -15
--- www/build.wiki
+++ www/build.wiki
@@ -33,42 +33,51 @@
3333
3434
<li><p>Select a version of of fossil you want to download. Click on its
3535
link. Note that you must successfully log in as "anonymous" in step 1
3636
above in order to see the link to the detailed version information.</p></li>
3737
38
-<li><p>Finally, click on the
39
-"Zip Archive" link. This link will build a ZIP archive of the
38
+<li><p>Finally, click on one of the
39
+"Zip Archive" or "Tarball" links, according to your preference.
40
+These link will build a ZIP archive or a gzip-compressed tarball of the
4041
complete source code and download it to your browser.
4142
</ol>
4243
4344
<h2>2.0 Compiling</h2>
4445
45
-<p>Follow these steps to compile on a unix platform
46
-(Linux, *BSD, MacOS, etc):</p>
47
-
4846
<ol>
4947
<li value="6">
50
-<p>Create a directory to hold the source code. Then unzip the
51
-ZIP archive you downloaded into that directory. You should be
48
+<p>Create a directory to hold the source code. Then unarchive the
49
+ZIP or tarball you downloaded into that directory. You should be
5250
in the top-level folder of that directory</p></li>
5351
5452
<li><p><b>(Optional:)</b>
5553
Edit the Makefile to set it up like you want. You probably do not
5654
need to do anything. Do not be intimidated: There are less than 10
5755
variables in the makefile that can be changed. The whole Makefile
5856
is only a few dozen lines long and most of those lines are comments.</p>
5957
60
-<li><p>Type "<b>make</b>"
58
+<li><p>Run make to build the "fossil" or "fossil.exe" executable. The
59
+details depend on your platform and compiler:
60
+
61
+<ol type="a">
62
+<li><p><i>Unix</i> &rarr; the default Makefile works on most unix and
63
+unix-like systems. Simply type "<b>make</b>".
64
+
65
+<li><p><i>Msys/MinGW</i> &rarr; Use the
66
+mingw makefile: "<b>make -f win/Makefile.mingw</b>"
67
+
68
+<li><p><i>VC++</i> &rarr; Use the msc makefile. First
69
+change to the "win/" subdirectory ("<b>cd win</b>") then run
70
+"<b>nmake /f Makefile.msc</b>".
71
+</ol>
6172
</ol>
6273
63
-<p>To build on windows, use an alternative makefile suitable for your
64
-particular build environment. The alternative windows makefiles are
65
-all found in the win/ subdirectory of the source tree. So, for example,
66
-if you want build using the
67
-[http://www.mingw.org/ | mingw/msys compiler package] for windows, then
68
-run "<b>make -f win/Makefile.mingw</b>" instead of just "<b>make</b>"
69
-in step 8 above.</p>
74
+<p>Note that Fossil requires the "zlib" compression library. This library
75
+is available by default on most unix systems, but it will typically have to
76
+be installed separately on windows systems. For windows builds, you may
77
+need to edit the makefile to tell it exactly where zlib is located on your
78
+system.</p>
7079
7180
<h2>3.0 Installing</h2>
7281
7382
<ol>
7483
<li value="9">
7584
--- www/build.wiki
+++ www/build.wiki
@@ -33,42 +33,51 @@
33
34 <li><p>Select a version of of fossil you want to download. Click on its
35 link. Note that you must successfully log in as "anonymous" in step 1
36 above in order to see the link to the detailed version information.</p></li>
37
38 <li><p>Finally, click on the
39 "Zip Archive" link. This link will build a ZIP archive of the
 
40 complete source code and download it to your browser.
41 </ol>
42
43 <h2>2.0 Compiling</h2>
44
45 <p>Follow these steps to compile on a unix platform
46 (Linux, *BSD, MacOS, etc):</p>
47
48 <ol>
49 <li value="6">
50 <p>Create a directory to hold the source code. Then unzip the
51 ZIP archive you downloaded into that directory. You should be
52 in the top-level folder of that directory</p></li>
53
54 <li><p><b>(Optional:)</b>
55 Edit the Makefile to set it up like you want. You probably do not
56 need to do anything. Do not be intimidated: There are less than 10
57 variables in the makefile that can be changed. The whole Makefile
58 is only a few dozen lines long and most of those lines are comments.</p>
59
60 <li><p>Type "<b>make</b>"
 
 
 
 
 
 
 
 
 
 
 
 
 
61 </ol>
62
63 <p>To build on windows, use an alternative makefile suitable for your
64 particular build environment. The alternative windows makefiles are
65 all found in the win/ subdirectory of the source tree. So, for example,
66 if you want build using the
67 [http://www.mingw.org/ | mingw/msys compiler package] for windows, then
68 run "<b>make -f win/Makefile.mingw</b>" instead of just "<b>make</b>"
69 in step 8 above.</p>
70
71 <h2>3.0 Installing</h2>
72
73 <ol>
74 <li value="9">
75
--- www/build.wiki
+++ www/build.wiki
@@ -33,42 +33,51 @@
33
34 <li><p>Select a version of of fossil you want to download. Click on its
35 link. Note that you must successfully log in as "anonymous" in step 1
36 above in order to see the link to the detailed version information.</p></li>
37
38 <li><p>Finally, click on one of the
39 "Zip Archive" or "Tarball" links, according to your preference.
40 These link will build a ZIP archive or a gzip-compressed tarball of the
41 complete source code and download it to your browser.
42 </ol>
43
44 <h2>2.0 Compiling</h2>
45
 
 
 
46 <ol>
47 <li value="6">
48 <p>Create a directory to hold the source code. Then unarchive the
49 ZIP or tarball you downloaded into that directory. You should be
50 in the top-level folder of that directory</p></li>
51
52 <li><p><b>(Optional:)</b>
53 Edit the Makefile to set it up like you want. You probably do not
54 need to do anything. Do not be intimidated: There are less than 10
55 variables in the makefile that can be changed. The whole Makefile
56 is only a few dozen lines long and most of those lines are comments.</p>
57
58 <li><p>Run make to build the "fossil" or "fossil.exe" executable. The
59 details depend on your platform and compiler:
60
61 <ol type="a">
62 <li><p><i>Unix</i> &rarr; the default Makefile works on most unix and
63 unix-like systems. Simply type "<b>make</b>".
64
65 <li><p><i>Msys/MinGW</i> &rarr; Use the
66 mingw makefile: "<b>make -f win/Makefile.mingw</b>"
67
68 <li><p><i>VC++</i> &rarr; Use the msc makefile. First
69 change to the "win/" subdirectory ("<b>cd win</b>") then run
70 "<b>nmake /f Makefile.msc</b>".
71 </ol>
72 </ol>
73
74 <p>Note that Fossil requires the "zlib" compression library. This library
75 is available by default on most unix systems, but it will typically have to
76 be installed separately on windows systems. For windows builds, you may
77 need to edit the makefile to tell it exactly where zlib is located on your
78 system.</p>
 
 
79
80 <h2>3.0 Installing</h2>
81
82 <ol>
83 <li value="9">
84
--- www/index.wiki
+++ www/index.wiki
@@ -20,10 +20,11 @@
2020
<li> [./quickstart.wiki | Quick Start]
2121
<li> [./build.wiki | Install]
2222
<li> [../COPYRIGHT-BSD2.txt | License]
2323
<li> [/timeline | Recent changes]
2424
<li> [./faq.wiki | FAQ]
25
+<li> [./contribute.wiki | Contributing]
2526
<li> [./permutedindex.wiki | Doc Index]
2627
<li> Mailing list
2728
<ul>
2829
<li> [http://lists.fossil-scm.org:8080/cgi-bin/mailman/listinfo/fossil-users | sign-up]
2930
<li> [http://www.mail-archive.com/[email protected] | archives]
3031
--- www/index.wiki
+++ www/index.wiki
@@ -20,10 +20,11 @@
20 <li> [./quickstart.wiki | Quick Start]
21 <li> [./build.wiki | Install]
22 <li> [../COPYRIGHT-BSD2.txt | License]
23 <li> [/timeline | Recent changes]
24 <li> [./faq.wiki | FAQ]
 
25 <li> [./permutedindex.wiki | Doc Index]
26 <li> Mailing list
27 <ul>
28 <li> [http://lists.fossil-scm.org:8080/cgi-bin/mailman/listinfo/fossil-users | sign-up]
29 <li> [http://www.mail-archive.com/[email protected] | archives]
30
--- www/index.wiki
+++ www/index.wiki
@@ -20,10 +20,11 @@
20 <li> [./quickstart.wiki | Quick Start]
21 <li> [./build.wiki | Install]
22 <li> [../COPYRIGHT-BSD2.txt | License]
23 <li> [/timeline | Recent changes]
24 <li> [./faq.wiki | FAQ]
25 <li> [./contribute.wiki | Contributing]
26 <li> [./permutedindex.wiki | Doc Index]
27 <li> Mailing list
28 <ul>
29 <li> [http://lists.fossil-scm.org:8080/cgi-bin/mailman/listinfo/fossil-users | sign-up]
30 <li> [http://www.mail-archive.com/[email protected] | archives]
31
+20 -14
--- www/makefile.wiki
+++ www/makefile.wiki
@@ -52,29 +52,34 @@
5252
7. th.c
5353
8. th.h
5454
5555
These two files are imports like the SQLite source files,
5656
and so are not preprocessed.
57
+
58
+The VERSION.h header file is generated from other information sources
59
+using a small program called:
60
+
61
+ 9. mkversion.c
5762
5863
The src/ subdirectory also contains documentation about the
5964
makeheaders preprocessor program:
6065
61
- 9. [../src/makeheaders.html | makeheaders.html]
66
+ 10. [../src/makeheaders.html | makeheaders.html]
6267
6368
Click on the link to read this documentation. In addition there is
6469
a [http://www.tcl.tk/ | Tcl] script used to build the various makefiles:
6570
66
- 10. makemake.tcl
71
+ 11. makemake.tcl
6772
6873
Running this Tcl script will automatically regenerate all makefiles.
6974
In order to add a new source file to the Fossil implementation, simply
7075
edit makemake.tcl to add the new filename, then rerun the script, and
7176
all of the makefiles for all targets will be rebuild.
7277
7378
Finally, there is one of the makefiles generated by makemake.tcl:
7479
75
- 11. main.mk
80
+ 12. main.mk
7681
7782
The main.mk makefile is invoked from the Makefile in the top-level
7883
directory. The main.mk is generated by makemake.tcl and should not
7984
be hand edited. Other makefiles generated by makemake.tcl are in
8085
other subdirectories (currently all in the win/ subdirectory).
@@ -89,31 +94,32 @@
8994
9095
<h1>3.0 Automatically generated files</h1>
9196
9297
The "VERSION.h" header file contains some C preprocessor macros that
9398
identify the version of Fossil that is to be build. The VERSION.h file is
94
-generated automatically from information extracted from the "manifest"
95
-and "manifest.uuid" source files in the root directory of the source tree.
99
+generated automatically from information extracted from the "manifest",
100
+"manifest.uuid", and "VERSION" source files in the root directory of the
101
+source tree.
96102
(The "manifest" and "manifest.uuid" files are automatically generated and
97103
updated by Fossil itself. See the [/help/setting | fossil set manifest]
98104
command for additional information.)
99105
100
-Under unix, there is an AWK script that converts manifest and manifest.uuid
101
-into VERSION.h. For windows, there is a C program: win/version.c.
102
-(Unix builds could also used the version.c convert, if desired, but AWK
103
-seems easier there.) To run the VERSION.h generator, first compile
104
-the win/version.c source file into a command-line program (named "version.exe")
106
+The VERSION.h header file is generated by
107
+a C program: src/mkversion.c.
108
+To run the VERSION.h generator, first compile the src/mkversion.c
109
+ source file into a command-line program (named "mkversion.exe")
105110
than run:
106111
107112
<blockquote><pre>
108
-version.exe manifest.uuid manifest VERSION.h
113
+mkversion.exe manifest.uuid manifest VERSION &gt;VERSION.h
109114
</pre></blockquote>
110115
111116
The pathnames in the above command might need to be adjusted to get the
112
-directories right. The point is that the manifest.uuid and manifest files
113
-in the root of the source tree are the first two arguments and the name of
114
-the generated VERSION.h file is the third and final argument.
117
+directories right. The point is that the manifest.uuid, manifest, and
118
+VERSION files
119
+in the root of the source tree are the three arguments and
120
+the generated VERSION.h file appears on standard output.
115121
116122
<h1>4.0 Preprocessing</h1>
117123
118124
There are three preprocessors for the Fossil sources. The mkindex
119125
and translate preprocessors can be run in any order. The makeheaders
120126
--- www/makefile.wiki
+++ www/makefile.wiki
@@ -52,29 +52,34 @@
52 7. th.c
53 8. th.h
54
55 These two files are imports like the SQLite source files,
56 and so are not preprocessed.
 
 
 
 
 
57
58 The src/ subdirectory also contains documentation about the
59 makeheaders preprocessor program:
60
61 9. [../src/makeheaders.html | makeheaders.html]
62
63 Click on the link to read this documentation. In addition there is
64 a [http://www.tcl.tk/ | Tcl] script used to build the various makefiles:
65
66 10. makemake.tcl
67
68 Running this Tcl script will automatically regenerate all makefiles.
69 In order to add a new source file to the Fossil implementation, simply
70 edit makemake.tcl to add the new filename, then rerun the script, and
71 all of the makefiles for all targets will be rebuild.
72
73 Finally, there is one of the makefiles generated by makemake.tcl:
74
75 11. main.mk
76
77 The main.mk makefile is invoked from the Makefile in the top-level
78 directory. The main.mk is generated by makemake.tcl and should not
79 be hand edited. Other makefiles generated by makemake.tcl are in
80 other subdirectories (currently all in the win/ subdirectory).
@@ -89,31 +94,32 @@
89
90 <h1>3.0 Automatically generated files</h1>
91
92 The "VERSION.h" header file contains some C preprocessor macros that
93 identify the version of Fossil that is to be build. The VERSION.h file is
94 generated automatically from information extracted from the "manifest"
95 and "manifest.uuid" source files in the root directory of the source tree.
 
96 (The "manifest" and "manifest.uuid" files are automatically generated and
97 updated by Fossil itself. See the [/help/setting | fossil set manifest]
98 command for additional information.)
99
100 Under unix, there is an AWK script that converts manifest and manifest.uuid
101 into VERSION.h. For windows, there is a C program: win/version.c.
102 (Unix builds could also used the version.c convert, if desired, but AWK
103 seems easier there.) To run the VERSION.h generator, first compile
104 the win/version.c source file into a command-line program (named "version.exe")
105 than run:
106
107 <blockquote><pre>
108 version.exe manifest.uuid manifest VERSION.h
109 </pre></blockquote>
110
111 The pathnames in the above command might need to be adjusted to get the
112 directories right. The point is that the manifest.uuid and manifest files
113 in the root of the source tree are the first two arguments and the name of
114 the generated VERSION.h file is the third and final argument.
 
115
116 <h1>4.0 Preprocessing</h1>
117
118 There are three preprocessors for the Fossil sources. The mkindex
119 and translate preprocessors can be run in any order. The makeheaders
120
--- www/makefile.wiki
+++ www/makefile.wiki
@@ -52,29 +52,34 @@
52 7. th.c
53 8. th.h
54
55 These two files are imports like the SQLite source files,
56 and so are not preprocessed.
57
58 The VERSION.h header file is generated from other information sources
59 using a small program called:
60
61 9. mkversion.c
62
63 The src/ subdirectory also contains documentation about the
64 makeheaders preprocessor program:
65
66 10. [../src/makeheaders.html | makeheaders.html]
67
68 Click on the link to read this documentation. In addition there is
69 a [http://www.tcl.tk/ | Tcl] script used to build the various makefiles:
70
71 11. makemake.tcl
72
73 Running this Tcl script will automatically regenerate all makefiles.
74 In order to add a new source file to the Fossil implementation, simply
75 edit makemake.tcl to add the new filename, then rerun the script, and
76 all of the makefiles for all targets will be rebuild.
77
78 Finally, there is one of the makefiles generated by makemake.tcl:
79
80 12. main.mk
81
82 The main.mk makefile is invoked from the Makefile in the top-level
83 directory. The main.mk is generated by makemake.tcl and should not
84 be hand edited. Other makefiles generated by makemake.tcl are in
85 other subdirectories (currently all in the win/ subdirectory).
@@ -89,31 +94,32 @@
94
95 <h1>3.0 Automatically generated files</h1>
96
97 The "VERSION.h" header file contains some C preprocessor macros that
98 identify the version of Fossil that is to be build. The VERSION.h file is
99 generated automatically from information extracted from the "manifest",
100 "manifest.uuid", and "VERSION" source files in the root directory of the
101 source tree.
102 (The "manifest" and "manifest.uuid" files are automatically generated and
103 updated by Fossil itself. See the [/help/setting | fossil set manifest]
104 command for additional information.)
105
106 The VERSION.h header file is generated by
107 a C program: src/mkversion.c.
108 To run the VERSION.h generator, first compile the src/mkversion.c
109 source file into a command-line program (named "mkversion.exe")
 
110 than run:
111
112 <blockquote><pre>
113 mkversion.exe manifest.uuid manifest VERSION &gt;VERSION.h
114 </pre></blockquote>
115
116 The pathnames in the above command might need to be adjusted to get the
117 directories right. The point is that the manifest.uuid, manifest, and
118 VERSION files
119 in the root of the source tree are the three arguments and
120 the generated VERSION.h file appears on standard output.
121
122 <h1>4.0 Preprocessing</h1>
123
124 There are three preprocessors for the Fossil sources. The mkindex
125 and translate preprocessors can be run in any order. The makeheaders
126

Keyboard Shortcuts

Open search /
Next entry (timeline) j
Previous entry (timeline) k
Open focused entry Enter
Show this help ?
Toggle theme Top nav button