Apple-2-SW/AppleIIAsm-Collection
1
0
Fork 0
mirror of https://github.com/nathanriggs/AppleIIAsm-Collection.git synced 2024-06-07 10:29:28 +00:00
Code Issues Projects Releases Wiki Activity

Documentation

Browse Source
This commit is contained in:
nathanriggs 2019-01-05 16:16:05 -05:00
parent 25c9affb02
commit 6d75f12bbc
2 changed files with 67 additions and 130 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

78
README.md
View File

@ -4,8 +4,8 @@ A general purpose ASM libriary for the Apple II. Assembled in Merlin 8 Pro
## Table of Contents
* Introduction
* Disk Overviews
* Disk 1: STDIO
*
* Disk 1: STDIO
*
* Macro Subroutine Overlap Table
* Detailed Descriptions: Macros
* Detailed Descriptions: Subroutines
@ -18,7 +18,7 @@ Ultimately, my aim is to create a large enough collection of routines to address
---
## Disk Overviews
Disk 1: STDIO
###Disk 1: STDIO
* stdio.mac: Standard Input/Output library.
* PRN: Flexible (screen) Printing routine
* PCR: Print Carraige Return
@ -37,67 +37,24 @@ Disk 1: STDIO
* TVLIN: Text Vertical Line Fill with Character [n]
* TFILL: Text Fill square [x1],[x2],[y1],[y2] with Character [n]
Disk 2: COMMON / REQUIRED
###Disk 2: COMMON / REQUIRED
* common.mac: Common, useful subroutines: memory swaps, etc.
* MEMFILL
* MEMMOVE
* DELAYMS
* ZSAVE
* ZLOAD
* required.mac: Set of Macros used across every disk in the library.
###Disk 3: MATH SUBROUTINES
* math8.mac: 8-bit and 16-bit Basic Math Macros.
MATH DISK
* math8.lib: 8-bit Integer Math Library.
* RND8
* RANDB
* MUL8
* DIV8
* math16.lib: 16-bit Integer Math Library.
* ADD16
* SUB16
* MUL16
* SDIV16
* UDIV16
* SREM16
* UREM16
* CMP16
* RND16
###Disk 4: FILE IO DISK
* fileio.mac: Macros for file input/output and disk operations.
IO DISK
* fileio.lib: File Input/Output Library.
* BSAVE (may be deleted)
* BLOAD (may be deleted)
* TMODE
* CMD
* FPRINT
* FPSTR
* FINPUT
* in the future, serial routines will also reside here.
###Disk 5: ARRAYS DISK
* arrays.mac: library for managing 1-dimensional 8-bit arrays.
ARRAYS DISK
* arrays81.lib: library for managing 1-dimensional 8-bit arrays.
* DIM81
* AGET81
* APUT81
* arrays82.lib: library for managing 2-dimensional 8-bit arrays.
* DIM82
* AGET82
* APUT82
* 16-bit array libraries will also be on this disk in the future
###Disk 6: STRINGS DISK
* strings.mac: library for managing strings.
STRINGS DISK
* strings.lib: Library for managing strings.
* STRCOMP
* STRCAT
* ASC2STR
* STR2ASC
* PRNSTR
* NUM2STR
* STR2NUM
* substrings.lib: Library for manipulating substrings.
* SUBPOS
* SUBCOPY
* SUBDEL
* SUBINS
---
## Future Disks
~~LORES DISK~~
* ~~lores.lib: Library for fast(er) graphics in low resolution mode.~~
@ -122,3 +79,6 @@ STRINGS DISK
~~80COL DISK~~
* ~~stdio library and some routines for double lores and double hires~~
~~PRINTER IO~~
~~SERIAL IO~~

119
README.md~
View File

@ -1,86 +1,60 @@
# AppleIIAsmLib
A general purpose ASM libriary for the Apple II. Assembled in Merlin 8 Pro
---
## Table of Contents
* Introduction
* Disk Overviews
* Disk 1: STDIO
*
* Macro Subroutine Overlap Table
* Detailed Descriptions: Macros
* Detailed Descriptions: Subroutines
---
## Introduction
This is a general purpose library in 6502 Assembly for the Apple II. I am learning both Git and Assembly for the first time as I create, update and maintain this, so expect some mishaps: wasted CPU cycles, weird documentation, accidental catastrophes, and so on. I am using Merin 8 Pro (DOS 3.3) for this project, but this should be fairly easy to convert to other assemblers as well as other 6502-based systems.
Ultimately, my aim is to create a large enough collection of routines to address any domain of development for the Apple II family in Assembly. I will be heavily relying on texts like Roger Wagner and Chris Torrence's _Assembly Lines_ and Lance Leventhal's _6502 Assembly Language Routines_, as well as a plethora of online sources. I'll do my best to acknowledge when a routine is inspired by (or mostly copied from) another source, and will exclude them from the Appache License 2.0 when necessary. If you find your own source here, but would rather it not be here, please reach out to me and I'll remove it immediately.
Planned libraries include, along with associated Macros:
---
## Disk Overviews
###Disk 1: STDIO
* stdio.mac: Standard Input/Output library.
* PRN: Flexible (screen) Printing routine
* PCR: Print Carraige Return
* INP: String Input Macro
* SCPOS: Set Cursor position at X,Y
* SETCX: Set Cursor Horizontal Position
* SETCY: Set Cursor Vertical Position
* CURF: Move Cursor Forward by [n] spaces
* CURD: Move Cursor Down by [n] spaces
* CURU: Move Cursor Up by [n] spaces
* CURB: Move Cursor Backward by [n] spaces
* RCPOS: Read Cursor Position
* PDL: Read Current Paddle State
* PBX: Read State of Paddle Button [x]
* THLIN: Text Horizontal Line Fill with Character [n]
* TVLIN: Text Vertical Line Fill with Character [n]
* TFILL: Text Fill square [x1],[x2],[y1],[y2] with Character [n]
###Disk 2: COMMON / REQUIRED
* common.mac: Common, useful subroutines: memory swaps, etc.
* required.mac: Set of Macros used across every disk in the library.
###Disk 3: MATH SUBROUTINES
* math8.mac: 8-bit and 16-bit Basic Math Macros.
CORE DISK
* stdio.lib: Standard Input/Output library.
* XPRINT
* DPRINT
* THLIN
* TVLIN
* CURSFOR
* CURSBAK
* CURSDN
* CURSUP
* TFILLA
* SINPUT
* GPBX
* common.lib: Common, useful subroutines: memory swaps, etc.
* MEMFILL
* MEMMOVE
* DELAYMS
* ZSAVE
* ZLOAD
###Disk 4: FILE IO DISK
* fileio.mac: Macros for file input/output and disk operations.
MATH DISK
* math8.lib: 8-bit Integer Math Library.
* RND8
* RANDB
* MUL8
* DIV8
* math16.lib: 16-bit Integer Math Library.
* ADD16
* SUB16
* MUL16
* SDIV16
* UDIV16
* SREM16
* UREM16
* CMP16
* RND16
###Disk 5: ARRAYS DISK
* arrays.mac: library for managing 1-dimensional 8-bit arrays.
IO DISK
* fileio.lib: File Input/Output Library.
* BSAVE (may be deleted)
* BLOAD (may be deleted)
* TMODE
* CMD
* FPRINT
* FPSTR
* FINPUT
* in the future, serial routines will also reside here.
###Disk 6: STRINGS DISK
* strings.mac: library for managing strings.
ARRAYS DISK
* arrays81.lib: library for managing 1-dimensional 8-bit arrays.
* DIM81
* AGET81
* APUT81
* arrays82.lib: library for managing 2-dimensional 8-bit arrays.
* DIM82
* AGET82
* APUT82
* 16-bit array libraries will also be on this disk in the future
STRINGS DISK
* strings.lib: Library for managing strings.
* STRCOMP
* STRCAT
* ASC2STR
* STR2ASC
* PRNSTR
* NUM2STR
* STR2NUM
* substrings.lib: Library for manipulating substrings.
* SUBPOS
* SUBCOPY
* SUBDEL
* SUBINS
---
## Future Disks
~~LORES DISK~~
* ~~lores.lib: Library for fast(er) graphics in low resolution mode.~~
@ -105,3 +79,6 @@ STRINGS DISK
~~80COL DISK~~
* ~~stdio library and some routines for double lores and double hires~~
~~PRINTER IO~~
~~SERIAL IO~~