Artifact e0f10c3d2d6b753527fbd498ce56aab836bf2712

File www/build.wiki part of check-in [5523218023a] - Add <title> markup to several of the embedded documentation pages. by drh on 2009-08-24 17:54:24.

<title>Fossil Documentation</title>

Installing Fossil

This page describes how to build and install Fossil. The whole process is designed to be very easy.

0.0 Using A Pre-compiled Binary

You can skip steps 1.0 and 2.0 below by downloading a pre-compiled binary appropriate for your platform. If you use a pre-compiled binary jump immediate to step 3.0.

1.0 Obtaining The Source Code

Fossil is self-hosting, so you can obtain a ZIP archive containing a snapshot of the latest version directly from fossil's own fossil repository. Follow these steps:

1. Pointer your web browser at http://www.fossil-scm.org/. Click on the "Login" menu button.

2. Log in as anonymous. The password is shown on screen. The reason for requiring this login is to prevent spiders from walking the entire website, downloading ZIP archives of every historical version, and thereby soaking up all our bandwidth.

3. Click on the Timeline or Leaves link at the top of the page.

4. Select a version of of fossil you want to download. Click on its link. Note that you must successfully log in as "anonymous" in step 1 above in order to see the link to the detailed version information.

5. On the version information page, click on the "[details]" hyperlink that appears right after the check-in comment at the top of the page.

6. Finally, click on the "Zip Archive" link. This link will build a ZIP archive of the complete source code and download it to your browser.

   Note to Mac users: The ZIP archive constructed by Fossil is a well-formed ZIP archive. However, the unarchiver that is built into the Mac has a bug in that it does not understand all well-formed ZIP archives. So you may get an error when the Mac goes to automatically extract the downloaded ZIP archive. We are still trying to figure out what it is about Fossil-generated ZIP archives that the Mac doesn't like. Until we do, your work-around is to manually extract the ZIP archive using the "unzip" command from a command-line shell.

2.0 Compiling

Follow these steps to compile:

6. Create a directory to hold the source code. Then unzip the ZIP archive you downloaded into that directory. You should be in the top-level folder of that directory

7. (Optional:) Edit the Makefile to set it up like you want. You probably do not need to do anything. Do not be intimidated: There are only 5 variables in the makefile that can be changed. The whole Makefile is only a few dozen lines long and most of those lines are comments.

8. Type "make"

3.0 Installing

9. The finished binary is named "fossil". Put this binary in a directory that is somewhere on your PATH environment variable. It does not matter where.

10. (Optional:) To uninstall, just delete the binary.