better docs

This commit is contained in:
~d6 2022-03-23 23:03:20 -04:00
parent f386614292
commit 0c5cbd982a
2 changed files with 28 additions and 4 deletions

4
femto
View File

@ -1,4 +1,8 @@
#!/bin/sh
#
# see femto.tal for source code
#
# see femto.txt for documentation
TTY=`stty -g`
uxnasm femto.tal femto.rom

View File

@ -13,16 +13,36 @@ 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 save changes
- doesn't support long lines/horizontal scrolling
- can't create new directories while saving
- doesn't support horizontal scrolling for long lines
- no search (or search&replace)
- no help messages
- few help messages
----- 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)
----- special key bindings -----
C-o save (TODO)
C-g cancel
C-o save
C-x quit
C-a go to beginning of line