nxu/femto.txt

---- femto text editor ----

based on nano.

draws graphics using ANSI control sequences.

this means the terminal must be in raw mode with echo
turned off. the `femto` wrapper script achieves this
using `sttry raw -echo` (it also restores the previous
terminal settings on exit).

---- WARNING ----

this is alpha quality software, still under active
development. although it seems to work fairly reliably
it has bugs!

please consider making backups (or using version control)
before femto this to modify important files.

(i'm in the midst of adding regex search so the code
is particularly untidy right now. sorry!)

---- getting started ----

you must provide a path to a file when starting femto:

    ./femto femto.tal

the femto launcher script makes many assumptions:

 - uxnasm and uxncli are both in the PATH
 - femto.tal is in the same directory as femto
 - femto.rom should be (re)assembled every time
 - femot.rom should be written in the same directory

once femto is not in active development a more robust
packaging process can be explored.

---- current status ----

 - can't create new files that don't already exist
 - can't create new directories while saving
 - doesn't support horizontal scrolling for long lines
 - no search (or search&replace)
 - no copy/paste
 - few help messages
 - doesn't support function keys, mouse, etc.

---- status line ----

the femto status line contains a lot of information:

 1. if the file has unsaved changes (**) or not (--)
 2. the file name (e.g. "scratch.tal")
 3. the number of bytes/lines (e.g. "[49 bytes, 8 lines]"
 4. the x/y cursor position (e.g. "(1,8)" for col 1, row 8)
 5. whether tabs ("[t]") or spaces ("[s]") are inserted by tab key

---- special key bindings ----

 C-g   cancel (used with commands like save, search, etc.)
 C-o   save
 C-x   quit

 C-b   move back one character (or LEFT ARROW)
 C-f   move forward one character (or RIGHT ARROW)
 C-n   move down one line (or DOWN ARROW)
 C-p   move up one line (or UP ARROW)
 M-v   page up (or PAGE DOWN)
 C-v   page down (or PAGE UP)

 C-a   go to beginning of line (or HOME)
 C-e   go to end of line (or END)
 M-<   go to start of file
 M->   go to end of file
 M-g   go to line
 C-l   center screen on cursor line

 C-d   delete
 M-c   toggle color scheme
 M-t   toggle tabs-vs-spaces indentation
 C-l   refresh screen (DEBUG)

    (C stands for Control)
    (M stands for Meta, often Alt or Option)