1. Overview

A bit about how conkeror is distributed at the moment, which patforms are supported, tested, etc., some notes about the spawn helper's purpose and its being optional. Talk about the spawn helper - optional, what it is for, supported only on UNIX at the moment.

2. Getting the Source Code

2.1. Nightly Snapshots

2.2. Git Repository

3. Installation on General UNIX

3.1. Prerequisites

XULRunner

etc.

Git

Optional prereq, only needed when building from git, etc.

C Compiler

Optional prereq, only needed when building spawn helper, etc.

3.2. Building the Spawn Helper

Notes about the build process being somewhat platform agnostic though editing the Makefile may or may not be necessary.

3.3. Installing to the System

4. Installation on OS X

4.1. Prerequisites

XULRunner

Mention that the .dmg distribution should be downloaded.

Git

Optional prereq, only needed when building from git, etc.

C Compiler

Optional prereq, only needed when building spawn helper, etc.

4.2. Building

Be sure to mention the important step of removing the old .app.

4.3. Creating an App Icon

The final installation step to create the App icon.

5. Installation on Windows

Watered down version of the UNIX instructions, excluding spawn helper, and appending .exe to things.

5.1. Prerequisites

XULRunner

etc.

Git

Optional prereq, only needed when building from source, etc.

5.2. Install to the System

6. Installation on Debian-Like Systems

6.1. Prerequisites

XULRunner

Installing xulrunner using apt. Don't need to talk about downloading xulrunner from Mozilla as Debian keeps up to date. Mention that this will happen automatically when using Debian's package or the nightly build .deb package.

Git

Optional prereq, only needed when building from git, etc.

C Compiler

Optional prereq, only needed when building spawn helper, etc.

6.2. Stable, Testing, and Unstable, Oh My!

Included, package will work but is currently very outdated. Recommend using nightly builds until updated packages make it into testing and unstable. Recommend stable that users who want to keep up-to-date stick with nightly builds.

6.3. Packaged Nightly Builds

Show XTaran's apt source.

6.4. Building .deb Packages from Git

Using the in-tree debian/ environment to build .deb packages.

6.5. Building from Git or Nightly Snapshot

Mention getting build deps with apt and refer to the general UNIX instructions.

6.6. Ubuntu Considerations

Nightlies untested on Ubuntu but should work; Ubuntu situation is similar to Debian situation, old package, should use nightlies until new packages make it in to Debian, thence into Ubuntu.

7. Installation on Fedora

7.1. Prerequisites

XULRunner

Installing xulrunner using yum or apt. Don't need to talk about downloading xulrunner from Mozilla as Fedora keeps up to date. Mention that this will happen automatically when using Fedora's package.

Git

Optional prereq, only needed when building from git, etc.

C Compiler

Optional prereq, only needed when building spawn helper, etc.

7.2. Fedora's Package

Installing Fedora's package using yum or apt.

7.3. Building from Git or Nightly Snapshot

Mention getting build deps with yum or apt and refer to the general UNIX instructions.

8. Installation on Other Platforms

Basically, your mileage may vary, please report success or failure here or to mailing list.