Documentation nits

This commit is contained in:
Joshua Bell 2018-06-02 11:32:30 -07:00
parent 6201f4d814
commit e6877b3785
5 changed files with 19 additions and 10 deletions

View File

@ -20,7 +20,7 @@ Contributions welcome! Preliminaries:
* Try and tackle some of the bugs in the [issue tracker](https://github.com/inexorabletash/a2d/issues?q=is%3Aissue+is%3Aopen+label%3Abug-in-original).
* Bug fixes will alter the binary, so should occur in branches. There's a `fixes` branch with some already.
1. Add new Desk Accessories
* List of ideas in the [issue tracker](https://github.com/inexorabletash/a2d/issues?q=is%3Aissue+is%3Aopen+label%3A%22feature+request%22)
* List of ideas in the [issue tracker](https://github.com/inexorabletash/a2d/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+label%3A%22Desk+Accessories%22+label%3A%22feature+request%22)
## DeskTop Disassembly Burn-Down
@ -50,8 +50,8 @@ invoker.s unscoped: 0 scoped: 0 raw: 2 unrefed: 0
produced by da65 which are _not_ in _two_ nested scopes. A scope is
used for the overall structure of a module, and a nested scope
is used for procedures. This counts labels which are not in either,
and thus may likely have some affinity for a particular address
and can't be safely moved.
and thus may have some affinity for a particular address
and therefore can't be safely moved.
* **scoped** counts the number of auto-generated labels like `L1234`
produced by da65 which _are_ inside two nested scopes. Once a label

View File

@ -29,7 +29,7 @@ syntax details.
lda value
cmp #limit ; less than the limit?
bcc less ; yes, so go do that
rol $1234 ; what does this do ???
```
@ -72,6 +72,7 @@ cases, e.g. `HideCursor`, `HideCursorImpl`, etc.
* Avoid magic numbers where possible:
* Define local variables (e.g. `ptr := $06`)
* Define offsets, constants, etc.
* Use `.struct` definitions to define offsets into structures
* Use math where necessary (e.g. `ldy #offset2 - offset1`)
* Use `.sizeof()` (or math if needed) rather than hardcoding sizes

View File

@ -908,7 +908,7 @@ Parameters:
### Application Use
_Notes specific to DeskTop Desk Accessories (DA) are included where usage notable differs._
_Notes specific to DeskTop Desk Accessories (DA) are included where usage differs._
#### Initialization

View File

@ -4,9 +4,10 @@ Disassembly of the original desk accessories:
* [Date](date.s) - complete!
* [Puzzle](puzzle.s) - complete!
* [Show Text File](show.text.file.s) - in progress! 95% complete
* [Sort Directory](sort.directory.s) - in progress! 40% complete
* [Sort Directory](sort.directory.s) - in progress! 60% complete
New desk accessories:
* [Show Image File](show.image.file.s) - complete!
* [This Apple](this.apple.s) - complete!
* [Eyes](eyes.s) - complete!
@ -22,7 +23,7 @@ See [API.md](API.md) for programming details
## Build Instructions
On Unix-like systems (including Mac OS X) `make all` should build
build the desk accessory files (original and new) into `out/`
the desk accessory files (original and new) into `out/`
output with a `.built` suffix.
For the original DAs, the `.built` and `.bin` files can be compared

View File

@ -25,13 +25,20 @@ MLI := $4000
.endstruct
.struct Pattern
bits .res 8
row0 .byte
row1 .byte
row2 .byte
row3 .byte
row4 .byte
row5 .byte
row6 .byte
row7 .byte
.endstruct
.struct MapInfo
viewloc .tag Point
mapbits .word ; screen_mapbits for windows
mapwidth .byte ; screen_mapwidth for windows
mapbits .word ; screen_mapbits=$2000 for windows, or bitmap bits
mapwidth .byte ; screen_mapwidth=$80 for windows, or stride for bitmap
reserved .byte
maprect .tag Rect ; a.k.a. cliprect
.endstruct