README

   1 Description
   2 ===========
   3
   4 Conkeror is a programmable Web browser based on Mozilla's
   5 XULRunner, inspired by GNU Emacs.
   6
   7 Type `C-h t' to view the tutorial, or see the wiki at
   8 http://conkeror.org for more information.
   9
  10 Official git repository: http://repo.or.cz/conkeror.git
  11
  12 Installation instructions
  13 -------------------------
  14
  15 Run `make' to compile conkeror-spawn-helper and create the
  16 conkeror launch script. Run `make install' to install
  17 conkeror.
  18
  19 Compilation options
  20 -------------------
  21
  22    - make PREFIX=/usr:
  23      Install conkeror to /usr instead of /usr/local.
  24      Needed in both the build stage and the install stage.
  25    - make DESTDIR=../pkg PREFIX=/usr install:
  26      Install conkeror to ../pkg/usr.
  27    - make etags:
  28      Extrude etags for ease of emacsing.
  29    - make dist:
  30      Create conkeror-$version.tar.gz, where
  31      version=$(grep '^Version=' application.ini | cut -d '=' -f 2)
  32    - make clean:
  33      Removes conkeror, conkeror-spawn-helper, versioned
  34      tarballs, and etags from the current working directory.
  35    - make uninstall:
  36      Remove files created by make install (remember to set
  37      PREFIX and DESTDIR, if need be). You should probably
  38      install by creating a proper package using your
  39      disribution's packaging tools instead.
  40
  41 Advanced Installation
  42 ---------------------
  43
  44 Please read the page from the following list most specific
  45 to your OS.
  46
  47 For Debian, Ubuntu, and similar OSes:
  48     http://conkeror.org/InstallationDebian
  49
  50 For Mac OS X:
  51     http://conkeror.org/InstallationOSX
  52
  53 For other Unix-like systems and Windows:
  54     http://conkeror.org/Installation
  55
  56 Community
  57 ---------
  58
  59   - Wiki: http://conkeror.org
  60   - IRC: irc://irc.freenode.net/#conkeror
  61   - Mailing list: http://conkeror.org/MailingList
  62   - Reporting bugs: http://conkeror.org/ConkerorBugs