moved and updated installation infos into INSTALL

 * list download archives in README instead

1 files changed, 89 insertions, 0 deletions

diff --git a/INSTALL b/INSTALL
index 7d1c323..e4319d0 100644
--- a/INSTALL
+++ b/INSTALL
@@ -3,12 +3,101 @@ Installation Instructions
 
 Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005,
 2006, 2007, 2008, 2009 Free Software Foundation, Inc.
+Copyright (C) 2013 Robin Haberkorn
 
    Copying and distribution of this file, with or without modification,
 are permitted in any medium without royalty provided the copyright
 notice and this notice are preserved.  This file is offered as-is,
 without warranty of any kind.
 
+SciTECO Build and Runtime Dependencies
+======================================
+
+ * Autotools, GNU C/C++ (v4.4 or later) or LLVM/gcc or LLVM/Clang
+ * Glib 2 as a cross-platform runtime library:
+   https://launchpad.net/~robin-haberkorn/+archive/sciteco
+ * Scintilla (v3.2.3 or later):
+   http://www.scintilla.org/
+ * Curses interface:
+   * Scinterm (v1.1 or later):
+     http://foicica.com/scinterm/
+   * NCurses (http://www.gnu.org/software/ncurses/),
+     PDCurses/XCurses (http://pdcurses.sourceforge.net/) or
+     PDCurses/Win32a (http://www.projectpluto.com/win32a.htm)
+   * other curses implementations might work as well but are untested
+ * GTK interface:
+   * GTK+ 2: http://www.gtk.org/
+ * Groff (only when formatting HTML manuals)
+ * Doxygen (only when generating developer documentation)
+
+When you are building from a source bundle (sciteco-*-bundle.tar.gz),
+you will not need to download Scintilla or Scinterm.
+
+Building from Source Bundle
+===========================
+
+The easiest way to build SciTECO is by using a source bundle:
+1. Make sure you can satisfy all the build dependencies (except
+   Scintilla/Scinterm which is included in the bundle).
+2. Unpack the source bundle. A directory "sciteco-VERSION" will
+   be created (VERSION is of course the release version you downloaded).
+3. Build Scintilla.
+   For building Scintilla/GTK+ something like this should be sufficient:
+   # cd sciteco-VERSION/scintilla/gtk
+   # make
+   For building Scintilla/Curses something like this should be sufficient:
+   # cd sciteco-VERSION/scintilla/scinterm
+   # make
+   This will create sciteco-VERSION/scintilla/bin/scintilla.a
+4. Build SciTECO.
+   An ordinary Autoconf build system is used, so something like this
+   should be sufficient:
+   # cd sciteco-VERSION/sciteco
+   # ./configure --with-interface=<INTERFACE>
+   # make
+   Where <INTERFACE> is the SciTECO interface to use.
+   It must match the Scintilla interface you have compiled.
+   For instance if you built Scintilla with Scinterm, you may use the
+   "ncurses" and "pdcurses" SciTECO interfaces.
+5. To install use something like:
+   # sudo make install
+6. You are recommended to use the included "teco.ini" as a starting point for your profile,
+   so copy it to "~/.teco_ini".
+
+For more details on building Autoconf-based projects refer to the
+remainder of this document.
+
+Building from Source Tar Ball or Repository
+===========================================
+
+You may also download a source tarball (sciteco-VERSION.tar.gz)
+or build from a cloned Git repository.
+When building from Git, you must first create the ./configure script:
+# autoreconf -i
+If you are using a source tarball ./configure is already included.
+
+The remainder of the build process is similar to building
+from a source bundle:
+ * Get Scintilla and Scinterm. The latter is only required if you
+   would like to build a Curses version of SciTECO.
+ * Install Scintilla/Scinterm according to their READMEs.
+   Usually you unpack Scinterm into a subdirectory of Scintilla
+   and run make...
+ * Apply the patches contained in the SciTECO sources: patches/*.patch
+   For instance:
+   # cd ~/scintilla
+   # for patch in SCITECO_PATH/patches/*.patch; do
+   > patch --merge -p1 <$patch
+   > done
+ * Build SciTECO just like described above.
+   If you did not use the same directory layout as the source bundles
+   do, you may have to specify the
+   --with-scintilla
+   and
+   --with-scinterm
+   site-configuration (./configure) options to tell SciTECO where
+   to find Scintilla/Scinterm.
+
 Basic Installation
 ==================