Reword the readme slightly in Gidubba and convert the readme, license, and source code t a Gidubba-friendly format

This commit is contained in:
CrazyEttin 2022-08-19 01:25:22 +03:00
parent 509c10cc70
commit 955992988c
3 changed files with 1545 additions and 1542 deletions

File diff suppressed because it is too large Load Diff

View File

@ -1,23 +1,24 @@
MIT License
===========
Copyright (c) 2022
Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be included
in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
MIT License
===========
Copyright (c) 2022
Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be included
in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.


View File

@ -1,43 +1,44 @@
Gidubba
========
Gidubba (Sumerian for 'stylus') is a simple line editor for the
Thingamajig computer architecture. Its git repository can be found at
https://ahti.space/git/crazyettin/Gidubba and that of Thingamajig at
https://ahti.space/git/crazyettin/Thingamajig.
System requirements
-------------------
Gidubba requires a terminal with local echo at address FFFF and
optionally a line printer at address FFFE and a punched tape reader and
punch at FFFD. If your setup differs from this you may have to modify
the code yourself.
Usage
-----
The commands are individual letters that can be followed by one or two
arguments separated by a comma. The first argument is a target line
number between 0 and FFFF and the second the range of lines between 0
and FF the command affects. Inserting lines to a target that does not
exist or the shortcut hash (#) appends them to the text; otherwise
targets or parts of ranges that do not exist are ignored.
Commands with a single argument:
* I: Insert a line or lines
Commands with two arguments:
* D: Delete a line
* L: List a line
Commands with no argument:
* P: Print (requires a printer)
* W: Writes to tape (requires a tape punch)
* R: Reads from tape (requires a tape reader)
* H: Halt
Both commands and arguments are case-insensitive. In both the command
prompt as well as when inserting lines sending an escape (^[) will allow
retyping the line in question. To finish inserting lines send a
substitute (^Z): the line on which this is done is not saved.
Gidubba
========
Gidubba (Sumerian for 'stylus') is a simple line editor for the
Thingamajig computer architecture. Its git repository can be found at
https://ahti.space/git/crazyettin/Gidubba and that of Thingamajig at
https://ahti.space/git/crazyettin/Thingamajig.
System requirements
-------------------
Gidubba requires a terminal with local echo at address FFFF and
optionally a line printer at address FFFE and a punched tape reader and
punch at FFFD. If your setup differs from this you may have to modify
the code yourself.
Usage
-----
The commands are individual letters that can be followed by one or two
arguments separated by a comma. The first argument is a target line
number between 0 and FFFF and the second the range of lines between 0
and FF the command affects. Inserting lines to a target that does not
exist or the shortcut hash (#) appends them to the text; otherwise
targets or parts of ranges that do not exist are ignored.
Commands with a single argument:
* I: Insert a line or lines
Commands with two arguments:
* D: Delete a line
* L: List a line
Commands with no argument:
* P: Print
* R: Read from the tape reader
* W: Write to the tape punch
* H: Halt
Both commands and arguments are case-insensitive. In both the command
prompt as well as when inserting lines sending an escape (^[) will allow
retyping the line in question. To finish inserting lines send a
substitute (^Z): the line on which this is done is not saved.