mostly fix move-beginning-of-line
[lice.git] / README
blobc01b834082199987db51c755dcd5c3eef893b793
1 Lisp Computing Environment (LiCE)
2 =================================
4 What is LiCE
5 ------------
7 LiCE is a GNU Emacs clone written entirely in common lisp. 
9 I've tested it on CMUCL, SBCL, CLISP, and Movitz. With a little work it could
10 probably run on more.
12 Installation
13 ------------
15 I'd recommend just loading the source from the current directory for
16 now.
18 ## CMUCL & SBCL
20 To run LiCE on CMUCL or SBCL you need asdf, cl-uffi, and
21 cl-ncurses. 
23 1. Boot your lisp in the lice-0.1 directory.
25 2. Load asdf, cl-uffi and cl-ncurses.
27 3. run (asdf:oos 'asdf:load-op :lice).
29 4. run (lice::lice)
31 ## Movitz
33 Here's what I did:
35 1. make a symlink lice-0.1/ to the losp/ directory.
37 2. add somewhere in los0.lisp (require :lice-0.1/all.lisp)
39 3. load movitz and run (create-image)
41 4. from all.lisp copy the commented out progn at the end. uncomment it
42    and run it at your repl. This will make lice load after los0, which
43    is crucial.
45 5. run (dump-image)
47 Now load the movitz image in an emulator or copy it to a floppy.
49 Documentation
50 -------------
52 There basically isn't any at this point. Most functions have
53 docstrings taken from Emacs. Your best documentation at this point is
54 the source.
56 Current Status
57 --------------
59 LiCE has the following implemented:
61 * interactive commands
63 * window splits
65 * input history
67 * minibuffer input, history, tab completion
69 * text properties
71 * a basic lisp-interactive-mode
73 * find-file and save-buffer
75 * basic buffer editing including the mark, a kill ring, and navigation
77 * universal arguments (C-u)
79 The code is still fairly volatile and in some cases hacky.