Merge remote-tracking branch 'origin/master' into for-steve
[sxemacs] / README
1 This directory tree holds version 22.1 of SXEmacs, the extensible,
2 customizable, self-documenting real-time display editor.
3
4 See the file `etc/NEWS' for information on new features and other
5 user-visible changes since the last version of SXEmacs.
6
7 The file `INSTALL' in this directory says how to build SXEmacs.
8
9 The file `PROBLEMS' contains information on many common problems that
10 occur in building, installing and running SXEmacs.
11
12 The file 'README.packages' will guide you in the installation of
13 (essential) add on packages.
14
15 The file `configure' is a shell script to acclimate SXEmacs to the
16 oddities of your processor and operating system.  It will create a
17 file named `Makefile' (a script for the `make' program), which helps
18 automate the process of building and installing SXEmacs.  See INSTALL
19 for more detailed information.
20
21 The file `configure.ac' is the input used by the autoconf program to
22 construct the `configure' script.
23
24 The file `Makefile.in' is a template used by `configure' to create
25 `Makefile'.
26
27 There are several subdirectories:
28
29 `src' holds the C code for SXEmacs (the SXXEmacs Lisp interpreter and its
30     primitives, the redisplay code, and some basic editing functions).
31 `lisp' holds the Emacs Lisp code for SXEmacs (most everything else).
32 `lib-src' holds the source code for some utility programs for use by
33     or with SXEmacs, like movemail and etags.
34 `etc' holds miscellaneous architecture-independent data files
35     SXEmacs uses, like the tutorial text and the Zippy the Pinhead quote
36     database.  The contents of the `lisp', `info' and `man'
37     subdirectories are architecture-independent too.
38 `lwlib' holds the C code for the toolkit objects used by SXEmacs.
39
40 `info' holds the Info documentation tree for SXEmacs.
41 `man' holds the source code for the SXEmacs info documentation tree.
42