File: README.md

package info (click to toggle)
zed 1.4-3
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 480 kB
  • ctags: 1,251
  • sloc: ml: 8,828; makefile: 64
file content (61 lines) | stat: -rw-r--r-- 1,514 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
Zed
===

Zed is an abstract engine for text edition. It can be used to write
text editors, edition widgets, readlines, ... You just have to
_connect_ an engine to your inputs and rendering functions to get an
editor.

Zed provides:

* edition state management,
* multiple cursor support,
* key-binding helpers,
* general purpose unicode rope manipulation functions.

Dependencies
------------

* [OCaml](http://caml.inria.fr/ocaml/) (>= 3.12)
* [findlib](http://projects.camlcity.org/projects/findlib.html)
* [Camomile](http://github.com/yoriyuki/Camomile) (>= 0.8)
* [react](http://erratique.ch/software/react)

For building the development version, you also need to install
[oasis](http://oasis.forge.ocamlcore.org/) (>= 0.3.0).

Installation
------------

To build and install zed:

    $ ./configure
    $ make
    $ make install

### Documentation _(optional)_

To build the documentation:

    $ make doc

It will then be installed by `make install`.

### Tests _(optionnal)_

To build and execute tests:

    $ ./configure --enable-tests
    $ make test

Modules
-------

* `Zed_edit`: the main module, it defines edition engines.
* `Zed_cursor`: manages cursors. Cursors are automatically updated
  when the text is modified.
* `Zed_lines`: maintains the offsets of beginning of lines.
* `Zed_input`: helpers for implementing key bindings.
* `Zed_macro`: helpers for writing macro systems.
* `Zed_utf8`: general purpose UTF-8 strings manipulation.
* `Zed_rope`: general purpose unicode ropes manipulation.