From 2e88d1522715367956fd9bab39b94d9d51d9ff5a Mon Sep 17 00:00:00 2001 From: Ivy Foster Date: Sun, 5 Apr 2015 17:21:14 -0500 Subject: [PATCH] Rename INSTALL to README, add additional info --- INSTALL | 10 ---------- README | 62 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 62 insertions(+), 10 deletions(-) delete mode 100644 INSTALL create mode 100644 README diff --git a/INSTALL b/INSTALL deleted file mode 100644 index c3c41b1..0000000 --- a/INSTALL +++ /dev/null @@ -1,10 +0,0 @@ - -Please read the page from the following list most specific to your OS. - - -For Debian, Ubuntu, and similar OSes: http://conkeror.org/InstallationDebian - -For Mac OS X: http://conkeror.org/InstallationOSX - -For other Unix-like systems and Windows: http://conkeror.org/Installation - diff --git a/README b/README new file mode 100644 index 0000000..41a2b14 --- /dev/null +++ b/README @@ -0,0 +1,62 @@ +Description +=========== + +Conkeror is a programmable Web browser based on Mozilla's +XULRunner, inspired by GNU Emacs. + +Type `C-h t' to view the tutorial, or see the wiki at +http://conkeror.org for more information. + +Official git repository: http://repo.or.cz/conkeror.git + +Installation instructions +------------------------- + +Run `make' to compile conkeror-spawn-helper and create the +conkeror launch script. Run `make install' to install +conkeror. + +Compilation options +------------------- + + - make PREFIX=/usr: + Install conkeror to /usr instead of /usr/local. + Needed in both the build stage and the install stage. + - make DESTDIR=../pkg PREFIX=/usr install: + Install conkeror to ../pkg/usr. + - make etags: + Extrude etags for ease of emacsing. + - make dist: + Create conkeror-$version.tar.gz, where + version=$(grep '^Version=' application.ini | cut -d '=' -f 2) + - make clean: + Removes conkeror, conkeror-spawn-helper, versioned + tarballs, and etags from the current working directory. + - make uninstall: + Remove files created by make install (remember to set + PREFIX and DESTDIR, if need be). You should probably + install by creating a proper package using your + disribution's packaging tools instead. + +Advanced Installation +--------------------- + +Please read the page from the following list most specific +to your OS. + +For Debian, Ubuntu, and similar OSes: + http://conkeror.org/InstallationDebian + +For Mac OS X: + http://conkeror.org/InstallationOSX + +For other Unix-like systems and Windows: + http://conkeror.org/Installation + +Community +--------- + + - Wiki: http://conkeror.org + - IRC: irc://irc.freenode.net/#conkeror + - Mailing list: http://conkeror.org/MailingList + - Reporting bugs: http://conkeror.org/ConkerorBugs -- 2.11.4.GIT