]> git.decadent.org.uk Git - ion3.git/blobdiff - README
Update cfg_kludge_flash for Flash 10
[ion3.git] / README
diff --git a/README b/README
index 62684eeaeeb413e5db9fe1288425d4e1d47dabe9..8a61477fca518d31171db5e73a86a54dff7a4a79 100644 (file)
--- a/README
+++ b/README
@@ -2,7 +2,7 @@
 Ion
 ===
 
 Ion
 ===
 
-Copyright (c) Tuomo Valkonen 1999-2006.
+Copyright (c) Tuomo Valkonen 1999-2009.
 
 tuomov at iki.fi
 
 
 tuomov at iki.fi
 
@@ -12,22 +12,14 @@ tuomov at iki.fi
 Building and installing
 -----------------------
 
 Building and installing
 -----------------------
 
-1. Make sure you have the following tools and libraries installed:
+1. Make sure you have the following tools and libraries installed (along
+   with, of course, standard X11 and libc stuff).
 
 
-    * GNU make
-    * Lua 5.1 (see <http://www.lua.org/>). 
+    * GNU make <http://www.gnu.org/software/make/>
+    * Lua 5.1 <http://www.lua.org/>
+    * gettext <http://www.gnu.org/software/gettext/>
 
 
-2. a) Edit `system.mk` to suit your system. Most GNU/Linux users should
-      need very little modifications to `system.mk`.
-
-   b) Alternatively, go to the directory `build/ac`, run `autoreconf`
-      and then `./configure`. Switch back to the top directory afterwards.
-      See `build/ac/README.autoconf` for details on parameters, especially 
-      if you are using the Debian Lua packages. If you try this method and 
-      it fails for some reason, please make sure `build/ac/system-ac.mk` 
-      does not exist before falling back to alternative a). Also in such
-      a case, find someone else to complain to; I (tuomov) will have 
-      nothing to do with autoconf.
+2. Edit `system.mk` to suit your system. 
 
 3. If you want to build some extra modules now or do not want to build
    some of the standard modules, edit `modulelist.mk`.
 
 3. If you want to build some extra modules now or do not want to build
    some of the standard modules, edit `modulelist.mk`.
@@ -50,7 +42,7 @@ Building and installing
    if you're using some X display/login manager. If `~/.xsession` does not 
    help and you're not using a display manager, modifying `~/.xinitrc` or 
    creating one based on your system's `xinitrc` (wherever that may be; 
    if you're using some X display/login manager. If `~/.xsession` does not 
    help and you're not using a display manager, modifying `~/.xinitrc` or 
    creating one based on your system's `xinitrc` (wherever that may be; 
-   use locate) may be what you need to do. Note that unlike `.xsession`, 
+   use `locate`) may be what you need to do. Note that unlike `.xsession`, 
    a `.xinitrc` should usually do much more setup than simply start a few
    programs of your choice.
 
    a `.xinitrc` should usually do much more setup than simply start a few
    programs of your choice.
 
@@ -64,11 +56,11 @@ Some optional installation steps
 1. The F5 and F6 keys expect to find the program `run-mailcap` to select
    a program to view a file based on its guessed MIME type. Unless you are
    using Debian, most likely you don't have it, but any other similar 
 1. The F5 and F6 keys expect to find the program `run-mailcap` to select
    a program to view a file based on its guessed MIME type. Unless you are
    using Debian, most likely you don't have it, but any other similar 
-   program (or just plain old text editor) will do as well - just the bindings
-   in `cfg_bindings.lua`. Of course, if you don't want to use the feature at 
-   this time or never, you may simply skip this step. If you want to use 
-   `run-mailcap`, it can be found from the following address, as a source 
-   tarball as well:
+   program (or just plain old text editor) will do as well -- just modify the
+   bindings in `cfg_ioncore.lua`. Of course, if you don't want to use the 
+   feature at this time or never, you may simply skip this step. If you want
+   to use `run-mailcap`, it can be found from the following address, as a 
+   source tarball as well:
    
        <http://www.debian.org/Packages/unstable/net/mime-support.html>
 
    
        <http://www.debian.org/Packages/unstable/net/mime-support.html>
 
@@ -80,9 +72,9 @@ Some optional installation steps
 
         15 05 * * * $SHAREDIR/ion-completeman -mksyscache
 
 
         15 05 * * * $SHAREDIR/ion-completeman -mksyscache
 
-   Replace `$SHAREDIR` with the setting from `system.mk` (or `system-ac.mk`
-   if you used autoconf). This example runs daily at 05:15, but you may 
-   modify the  run times to your needs; see the crontab manual. 
+   Replace `$SHAREDIR` with the setting from `system.mk`. This example 
+   runs daily at 05:15, but you may modify the  run times to your needs;
+   see the crontab manual. 
    
    If you can't or do not want to build a system-wide man page cache, run
    `crontab -e` as your normal user and replace `-mksyscache` with
    
    If you can't or do not want to build a system-wide man page cache, run
    `crontab -e` as your normal user and replace `-mksyscache` with
@@ -92,8 +84,8 @@ Some optional installation steps
    `-mk*cache` argument once manually to build the initial cache.
    
    If the `MANPATH` environment variable is not set on your system and it
    `-mk*cache` argument once manually to build the initial cache.
    
    If the `MANPATH` environment variable is not set on your system and it
-    does not have the `manpath` command (or it does not print anything 
-   sensible), you may also want to set the `ION_MC_MANPATH` environment
+   does not have the `manpath` command (or it does not print anything 
+   sensible), you may also want to set the `ION_MANPATH` environment
    variable to the list of paths where the system stores manual pages.
 
 
    variable to the list of paths where the system stores manual pages.
 
 
@@ -118,20 +110,17 @@ Credits
 
 Ion was written by Tuomo Valkonen.
 
 
 Ion was written by Tuomo Valkonen.
 
-The autoconf script written by Tom Payne for the most part.
-
 The dock module was written by Tom Payne and Per Olofsson.
 
 The dock module was written by Tom Payne and Per Olofsson.
 
-`share/ion-completefile/ion-completefile.c` is based on editline, (c)
+`utils/ion-completefile/ion-completefile.c` is based on editline, (c)
 1992 Simmule Turner and Rich Salz. See the file for details.
 
 1992 Simmule Turner and Rich Salz. See the file for details.
 
-The code that `de/fontset.c` is based on was apparently originally written 
-by Tomohiro Kubota; see
-<http://www.debian.org/doc/manuals/intro-i18n/ch-examples.en.html#s13.4.5>.
+The code that `de/fontset.c` is based on seems to have been originally
+written by Tomohiro Kubota, but see the file for details.
 
 
-Various patches have been contributed by other individuals unlisted here.
-See the mailing list archives and the darcs source repository history at
-<http://iki.fi/tuomov/repos/>. For translators see the individual `.po`
-files in `po/`.
+Various (minor) patches have been contributed by other individuals 
+unlisted  here. See the mailing list archives and the darcs source 
+repository history at <http://iki.fi/tuomov/repos/>. For translators
+see the individual `.po` files in `po/`.
 
 See `libtu/README` for code by others integrated into libtu.
 
 See `libtu/README` for code by others integrated into libtu.