Browse Source

Update readme

master
Julian Noble 1 month ago
parent
commit
f0add9180f
  1. 25
      README.md

25
README.md

@ -7,8 +7,9 @@ BSD license
### Features
- default ansi color output - toggle with 'colour on' and 'colour off' (or set NO_COLOR environment variable)
- convenient and comprehensive in-terminal display of tk, web and terminal ANSI colour names and codes.
- rendering of old-school Ansi art (cp437) in the terminal
![Ansi art courtesy of roy-sac.com](hype_roysac.png?raw=true "Ansi art")
![Ansi art courtesy of roy-sac.com](hype_roysac.png?raw=true "Ansi cp437 art")
- Relatively easy compositing of text blocks containing Ansi colour codes - (or rendered versions of ansi containing movement and other controls)
```
proc welcome_test {} {
@ -25,7 +26,7 @@ BSD license
set framed [textblock::frame -type arc -title [a+ cyan]Compositing[a] -subtitle [a+ red]ANSI[a] -ansiborder [a+ web-orange] $contents]
}
```
![textblock composition of Ansi strings](compositing_ansi.png?raw=true "Compositing Ansi")
![textblock composition of Ansi strings](compositing_ansi.png?raw=true "Compositing Ansi in Tcl")
- experimental functional/pattern-matching language features. (will not be performant until more work is done on script compilation)
e.g.1 basic pipeline with 2 segments
@ -76,15 +77,25 @@ BSD license
- `d/ <subdir>` - switch to subdir and list contents in one operation
- `dd/` - move up one directory and output listing. Roughly equivalent to `cd ..` followed by dir or ls (alias `../`)
- `d/new <folder>` - create a child directory and switch to it in one operation. (alias `./new <folder>`)
- Ability to create zipfs wrapped applications with all required libraries built in.
- Additional libraries
- improved fork of tcllib's imap4 (punk::imap4)
- netbox client library (punk::netbox)
- telnet client with support for cp437
e.g can render mapscii.me with mouse support, and can view the ANSI max-headroom movie at 1984.ws
- A feature-rich argument processor that can be used purely to generate function documentation, or
also to process and validate flags and values (punk::args)
The argument processor/documentor can display command synopses, grids of applicable argument choices,
and indications of when short-forms (prefixes for flags/arguments/values) are applicable.
#### missing
- raw mode REPL (read-eval-print-loop) to allow commandline completion etc. Initial version is linemode. (intention is to allow different REPLs to be plugged)
- documentation!
- tests
- signal handling on unix-like platforms (ctrl-c implemented on windows only)
- raw mode REPL (read-eval-print-loop) to allow commandline completion etc (undergoing development).
- documentation is incomplete.
- tests coverage is low.
- signal handling on unix-like platforms (ctrl-c implemented on windows only).
#### very unripe parts:
- commandline options - in need of urgent work to document and lock down specifics - in particular: punkshell somescript.tcl needs a fix to emit errors.
- commandline options - in need of work to document and lock down specifics - in particular: punkshell somescript.tcl needs a fix to emit errors.
- shellfilter - api is clumsy
- scriptlib - will likely be reorganised/pruned significantly

Loading…
Cancel
Save