xref: /zile/
Name Date Size

..27-Apr.-20224 KiB

.gitignoreH A D04-May-2021425

.gitmodulesH A D01-Jun.-2018182

.prev-versionH A D04-May-20216

AUTHORSH A D13-Aug.-2017582

bootstrapH A D16-Oct.-2020154.2 KiB

bootstrap.confH A D19-Mar.-20215 KiB

build-aux/H19-Mar.-20214 KiB

cfg.mkH A D04-May-20211.3 KiB

ChangeLogH A D19-Mar.-202114

configure.acH A D04-May-20211.9 KiB

doc/H19-Mar.-20214 KiB

FAQH A D15-Jan.-20184 KiB

gl/H01-Jun.-20184 KiB

gl-mod/bootstrap/H01-Jun.-20184 KiB

gnulib/H13-Aug.-20174 KiB

m4/H19-Mar.-20214 KiB

Makefile.amH A D19-Mar.-20212 KiB

NEWSH A D04-May-202126.7 KiB

READMEH A D19-Mar.-20216.8 KiB

src/H07-Nov.-20214 KiB

tests/H04-May-202112 KiB

THANKSH A D13-Aug.-20172.3 KiB

README

1GNU Zile
2========
3
4GNU Zile is free software, licensed under the GNU GPL.
5
6Copyright (c) 1997-2016 Free Software Foundation, Inc.
7
8**Copying and distribution of this file, with or without modification,
9are permitted in any medium without royalty provided the copyright
10notice and this notice are preserved.**
11
12_This file is marked up in [MultiMarkdown][] syntax_.
13
14  [MultiMarkdown]: http://fletcherpenney.net/multimarkdown
15
16------------------------------------------------------------------------
17
18Contents
19========
20
211. [INTRODUCTION][]
22   * [Source Layout][]
23   * [Web Pages][]
24   * [Mailing Lists][]
252. [OBTAINING THE LATEST SOURCES][]
26   * [Official Release][]
27   * [Development Sources][]
283. [REPORTING BUGS][]
29
30------------------------------------------------------------------------
31
32INTRODUCTION
33============
34
35GNU Zile (_Zile Is Lossy Emacs_) is a lightweight [Emacs][] clone. Every
36Emacs user should feel at home with Zile. Zile is aimed at small
37footprint systems (a typical binary is about 100Kb) and quick editing
38sessions (it starts up and shuts down instantly).
39
40Zile is written in **ISO C99** using **POSIX.1-2008** APIs, and [libgc][].
41It can be built on many other platforms thanks to its use of [gnulib][].
42
43  [Emacs]:   http://www.gnu.org/s/emacs
44  [libgc]:   http://www.hpl.hp.com/personal/Hans_Boehm/gc
45  [gnulib]:  http://www.gnu.org/s/gnulib
46
47
48Source Layout
49-------------
50
51 * See file `AUTHORS` for the names of maintainers past and present.
52 * See file `COPYING` for copying conditions.
53 * See file `FAQ` for a selection of a Frequently Answered Questions.
54 * See file `INSTALL` for generic compilation and installation
55   instructions.
56 * See file `NEWS` for a list of major changes in each Zile release.
57 * See file `THANKS` for a list of important contributors.
58
59The rest of the files in the top-level directory are part of the
60[Autotools]() build system used to compile and install Zile.
61
62 * Directory `build-aux` contains helper scripts used to build Zile.
63 * Directory `doc` contains files used to create Zile's documentation.
64 * Directory `gl` contains Zile-specific patches to standard [gnulib]().
65 * Directory `lib` contains [gnulib]() source modules used by Zile.
66 * Directory `m4` contains a mixture of [gnulib]() supplied and Zile-
67   specific macros for rebuilding the `configure' script.
68 * Directory `src` contains the source code used to build Zile.
69 * Directory `tests` contains a small suite of tests used by
70   `make check` to sanity check a newly built `src/zile` binary.
71
72  [Autotools]: http://sourceware.org/autobook/
73
74
75Web Pages
76---------
77
78GNU Zile's home page is at:
79
80  > <http://www.gnu.org/s/zile/>
81
82GNU Zile development is co-ordinated from Zile's project page at GNU
83Savannah:
84
85  > <http://savannah.gnu.org/projects/zile/>
86
87An archive of past releases is also archived at:
88
89  > <http://ftp.gnu.org/gnu/zile/>
90
91But please use a mirror for faster downloads and to reduce stress on the
92main gnu machine. The following link will automatically redirect to a
93nearest mirror:
94
95  > <http://ftpmirror.gnu.org/zile/>
96
97Or you can manually select a mirror from the list at:
98
99  > <http://www.gnu.org/order/ftp.html>
100
101
102Mailing Lists
103-------------
104
105Questions, comments and requests should be sent to the Zile user's list
106at <help-zile@gnu.org>.
107
108See [REPORTING BUGS][] for the bug reporting mailing list address.
109
110
111OBTAINING THE LATEST SOURCES
112============================
113
114If you are just building GNU Zile from an [Official Release][], you
115should not normally need to run `./bootstrap` or `autoreconf`; just go
116ahead and start with `./configure`.
117
118If you are trying to build GNU Zile from the [Development Sources][],
119`./configure` will not work until the `./bootstrap` script has completed
120successfully.
121
122
123Official Release
124----------------
125
126Compressed tarballs of all recent GNU Zile releases are available from:
127
128  > <http://ftpmirror.gnu.org/zile>
129
130Compressed tarballs of unstable prereleases are sometimes made available
131from:
132
133  > <ftp://alpha.gnu.org/gnu/zile>
134
135Official tarballs are supplied with a [GnuPG][] detached signature file
136so that you can verify that the corresponding tarball is still the same
137file that was released by the owner of its GPG key ID. First, be sure to
138download both the .sig file and the corresponding release:
139
140    wget http://ftpmirror.gnu.org/zile/zile-2.3.24.tar.gz
141    wget http://ftpmirror.gnu.org/zile/zile-2.3.24.tar.gz.sig
142
143then run a command like this:
144
145    gpg --verify zile-2.3.24.tar.gz.sig
146
147If that command fails because you don't have the required public key,
148then run this command to import it:
149
150    gpg --keyserver keys.gnupg.net --recv-keys 80EE4A00
151
152and then rerun the `gpg --verify' command.
153
154Generic instructions for how to build GNU Zile from a release tarball
155are contained in the file `INSTALL`. Additionally, If you wish to use a
156non-standard curses library name, this can be specified using
157`CURSES_LIB` and `CPPFLAGS`. For example, to use the X version of
158[PDcurses][]:
159
160    CPPFLAGS=/usr/local/include/xcurses CURSES_LIB=-lXCurses ./configure
161
162If you are missing any of the prerequisite libraries needed to
163successfully build GNU Zile, the `configure` script will abort itself
164and tell you right away.
165
166  [GnuPG]:    http://www.gnupg.org/
167  [PDcurses]: http://pdcurses.sf.ne
168
169
170Development Sources
171-------------------
172
173Zile development sources are maintained at the GNU Savannah git server:
174
175  > [git://git.sv.gnu.org/zile.git][gitbrowser]
176
177You can fetch a read-only copy with:
178
179    git clone https://git.savannah.gnu.org/git/zile.git
180
181Normally, you just need to run `./bootstrap`, and it will either get
182everything ready so that you can then run `./configure` as would for a
183release tarball, or else tell you if your machine is missing some
184packages that it needs in order to do that.
185
186  [gitbrowser]: http://git.sv.gnu.org/cgit/zile.git
187
188Zile is written in Vala; to build it you need valac version 0.52 or later,
189glib 2.0 and libgee.
190
191
192REPORTING BUGS
193==============
194
195If this distribution doesn't work for you, before you report the
196problem, please try upgrading to the latest released version first, to
197see whether your issue has been fixed already. If you can, please also
198check whether the latest development sources for the next release still
199exhibit the problem (see [OBTAINING THE LATEST SOURCES][] above).
200
201Please send bug reports, feature requests and patches to
202<bug-zile@gnu.org> or, preferably, file them directly in the relevant
203tracker at <http://savannah.gnu.org/projects/zile/>.
204
205When you are ready to submit a report, first, please read this:
206
207  > <http://www.chiark.greenend.org.uk/~sgtatham/bugs.html>
208
209Zile has a suite of Lisp tests in the tests directory of the source
210distribution, which you can run with:
211
212    make check
213
214If, when you report a bug, you can create a similar test that
215demonstrates it, the maintainers will be most grateful, and it will
216prevent them from accidentally reintroducing the bug in a subsequent
217release.
218