README (2584B)
1 WARNING: This is work in progress! A lot of bugs still need to be fixed 2 before this can be used as a real text editor. 3 4 ledit is a vi-like text editor for people who switch between keyboard 5 layouts frequently and/or work with languages that require complex text 6 layout. 7 8 Additionally, it allows multiple views on a text buffer so that different 9 parts of a file can be shown at the same time. 10 11 REQUIREMENTS: 12 pango (with xft), xlib (extensions: xkb, xdbe), 13 xcursor, libutf8proc (if ENABLE_UTF8PROC is set) 14 15 Note: xcursor technically wouldn't be needed since it's just a dependency 16 of features in ctrlsel that currently aren't being used, but I will 17 probably use those features later, so I was too lazy to remove those parts. 18 19 Packages to install: 20 On OpenBSD: pango, libutf8proc 21 On Debian-based systems: 22 libpango1.0-dev, libx11-dev, libxkbfile-dev libxcursor-dev, libutf8proc-dev 23 (this is just from memory, I need to test it with a fresh system sometime) 24 25 Installation: 26 Simply run 'make' and 'make install' 27 To compile with debugging symbols and some debug output, run 'make DEV=1' 28 To compile with -fsanitize=address,undefined, run 'make SANITIZE=1' 29 To disable utf8proc support, run 'make ENABLE_UTF8PROC=0'. Currently, 30 utf8proc is only required for utf8-aware uppercase and lowercase functions. 31 32 A sample configuration file can be found in leditrc.example. 33 Copy this to ~/.leditrc in order to use it. 34 35 Note: If you think important key bindings are missing in the default 36 configuration, let me know. It definitely isn't set in stone yet. 37 38 The documentation can be viewed in ledit.1 and leditrc.5 or at the following locations: 39 40 gopher://lumidify.org/0/doc/ledit/ledit-current.txt 41 gopher://4kcetb7mo7hj6grozzybxtotsub5bempzo4lirzc3437amof2c2impyd.onion/0/doc/ledit/ledit-current.txt 42 http://lumidify.org/doc/ledit/ledit-current.html 43 http://4kcetb7mo7hj6grozzybxtotsub5bempzo4lirzc3437amof2c2impyd.onion/doc/ledit/ledit-current.html 44 https://lumidify.org/doc/ledit/ledit-current.html 45 46 gopher://lumidify.org/0/doc/ledit/leditrc-current.txt 47 gopher://4kcetb7mo7hj6grozzybxtotsub5bempzo4lirzc3437amof2c2impyd.onion/0/doc/ledit/leditrc-current.txt 48 http://lumidify.org/doc/ledit/leditrc-current.html 49 http://4kcetb7mo7hj6grozzybxtotsub5bempzo4lirzc3437amof2c2impyd.onion/doc/ledit/leditrc-current.html 50 https://lumidify.org/doc/ledit/leditrc-current.html 51 52 Note that the documentation isn't particularly great. 53 This might be fixed sometime in the future. 54 55 Also note that nothing is stable at the moment. In particular, some of the 56 function names mentioned in leditrc.5 will probably be changed still.