#pragma section-numbers on <> = 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. = Getting the Source Code = == Nightly Snapshots == == Git Repository == = Installation on General UNIX = == Prerequisites == '''XULRunner''' etc. '''Git''' Optional prereq, only needed when building from git, etc. '''C Compiler''' Optional prereq, only needed when building spawn helper, etc. == Building the Spawn Helper == Notes about the build process being somewhat platform agnostic though editing the Makefile may or may not be necessary. == Installing to the System == = Installation on OS X = == 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. == Building == Be sure to mention the important step of removing the old .app. == Creating an App Icon == The final installation step to create the App icon. = Installation on Windows = Watered down version of the UNIX instructions, excluding spawn helper, and appending {{{.exe}}} to things. == Prerequisites == '''XULRunner''' etc. '''Git''' Optional prereq, only needed when building from source, etc. == Install to the System == = Installation on Debian-Like Systems = == 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. == 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. == Packaged Nightly Builds == Show XTaran's apt source. == Building .deb Packages from Git == Using the in-tree {{{debian/}}} environment to build {{{.deb}}} packages. == Building from Git or Nightly Snapshot == Mention getting build deps with apt and refer to the general UNIX instructions. == 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. = Installation on Fedora = == 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. == Fedora's Package == Installing Fedora's package using yum or apt. == Building from Git or Nightly Snapshot == Mention getting build deps with yum or apt and refer to the general UNIX instructions. = Installation on Other Platforms = Basically, your mileage may vary, please report success or failure here or to mailing list.