Add to / fix formatting in 1991/ant/README.md

In the judges' comments add some humour.

Add a try section.

Note that a file is needed for the program to do anything (that is a
file that exists) - not specifying an arg will exit without doing
anything at all.

Explain how to enter form-feed as this is important.

Fix formatting.
This commit is contained in:
Cody Boone Ferguson committed 2023-03-19 06:05:08 -07:00
1 parent 94ece1f48d
commit 9c2c19582c
1 file changed
+30 -6
+30 -6
View File
@@ -10,17 +10,35 @@
make all make all
### To run ## To run:
./ant some_file
NOTE: the file must already exist and not specifying any arg will make the
program exit without doing anything.
## Try:
cp README.md hill cp README.md hill
./ant hill ./ant hill
## Judges' comments ## Judges' comments:
The author was kind enough to supply a list of references below, The author was kind enough to supply a list of references below,
in case you are still confused after read the source! :-) in case you are still confused after read the source! :-)
## Author's comments BTW: you've most likely heard the joke that if you want a pseudo-random string
of characters you can put a user unfamiliar with vi(m) in a vi(m) session (in
insert mode) and ask them to exit. Well in this case you're likely to have this
problem if you ARE a vi(m) user! :-) ... especially if you don't read the
information below. This means if you're reading this in vi(m) you'll have to
exit this like in normal vi(m) and then exit `./ant` differently.
NOTE: to enter form feed you should be able to hit `ctrl-L`. This will allow you
to exit insert mode rather than ESC like in normal vi(m). See the author's
commands section for other commands.
## Author's comments:
Ant's Editor vIOCCC91 Ant's Editor vIOCCC91
@@ -31,7 +49,8 @@
Non-printable characters may have unpredictable results depending Non-printable characters may have unpredictable results depending
on the implementation of CURSES. on the implementation of CURSES.
COMMANDS ### COMMANDS:
h j k l left, down, up, right cursor movement h j k l left, down, up, right cursor movement
H J K L word left, page down, page up, word right H J K L word left, page down, page up, word right
[ ] beginning and end of line [ ] beginning and end of line
@@ -42,10 +61,14 @@
R refresh the screen R refresh the screen
Q quit Q quit
EXIT STATUS ### EXIT STATUS:
0 success 0 success
2 missing edit filename 2 missing edit filename
### ABOUT THIS ENTRY:
The BUF size should be set at compile time to 32767. This value The BUF size should be set at compile time to 32767. This value
was used because the Sozobon C compiler for the Atari ST has 16 was used because the Sozobon C compiler for the Atari ST has 16
bit ints and a limit on the size of arrays & structures of 32k. bit ints and a limit on the size of arrays & structures of 32k.
@@ -78,7 +101,8 @@
scrolling the screen with long lines. Paging up and down should scrolling the screen with long lines. Paging up and down should
work correctly, however. work correctly, however.
REFERENCES ### REFERENCES:
[Fin80] Craig A. Finseth, "Theory and Practice of Text Editors or [Fin80] Craig A. Finseth, "Theory and Practice of Text Editors or
A Cookbook For An EMACS", TM-165, MIT Lab. for Computer A Cookbook For An EMACS", TM-165, MIT Lab. for Computer
Science Science