Fix a small bug and tweak a little the syntax module.
[eco.git] / README
blob140aedbbdb6eeb68076376c69560e7c3ca56deaf
1                                 Eco
2                         A simple text editor.
4 Eco is an Open Source project covered by the GNU General Public License
5 version 2, check the COPYING file for more details.
7 It is maintained by Diego Hernan Borghetti and only test in Linux, so
8 ideas, patch, bugs, whatever are welcome to bdiego@gmail.com
10 Eco is a small and simple text editor, need termios (ncurses) for set
11 the terminal characteristics and ansi scape sequence to draw in the
12 terminal.
14 The build and install process is really simple, just type make and
15 following by make install.
17 The Makefile is really simple now, if you need special library, cc flag
18 or any other thing, you can use the BUILD variable.
20 The default directory to install is HOME/bin, but you can change it
21 in the Makefile (PREFIX variable).
24 Key binding
25 ===========
27  The key binding can not be change from config file, it's build-in, and
28 it's:
30         CX - CC - Quit
31         CX - CS - Save file
32         CK      - Kill the current line
33         CR      - Rotate the view
34         CG      - Goto to line N
35         CX - CF - Find a file
36         CU      - Force a scren update
37         CS      - Forward search
38         CB      - Backward search
39         CX - CR - Search and replace
40         CH      - Backspace
41         CI      - Tab
42         CM      - Carriage ret
44  Other key binding that maybe change:
45         CC      - Cut the current line (put in the kill buffer)
46         CY      - Paste the text from the kill buffer into the current buf
47         CL      - Clean the kill buffer
49 Colors
50 ======
52  Eco only use color for two things, the status line and the line where the
53 cursor is, both color can be set in the config file (HOME/.eco) in two
54 section like:
56 [ View ]
57         foreground = COLOR
58         background = COLOR
60 [ Screen ]
61         current_line_foreground = COLOR
62         current_line_background = COLOR
63         empty_char_fg = COLOR
64         empty_char_bg = COLOR
66 and COLOR can be:
67         0 - Black
68         1 - Red
69         2 - Green
70         3 - Yellow
71         4 - Blue
72         5 - Magenta
73         6 - Cyan
74         7 - White