Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ckormanyos committed Jan 10, 2024
1 parent cc374a2 commit 1ea8c6a
Showing 1 changed file with 18 additions and 12 deletions.
30 changes: 18 additions & 12 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@ for the z80-based TI-84 Plus monochrome graphics calculator. It runs in the
open `Asm(prgm)` interface provided in the calculator's `CATALOG` menu.
It uses the TI-84's on-board Z80 processor.

The reference application implements parallel _blinky_ and _hello_-_world_ test-shows.
The reference application implements parallel _blinky_ and _hello_-_world_ text-shows.
A minimalistic cooperative multitasking scheduler controls
the presentation of the associated ASCII-text messages.
the presentations of the associated ASCII-text messages.

The text-shows _ON_/_OFF_ and _hello_/_world_ are written on the calculator screen.
Text is used since there is no actual LED present on the calculator-target system.
Expand All @@ -43,7 +43,7 @@ There is minimal use of assembly for startup and to interface with

Execution:
- After build, locate `bin/refapp.8xp`.
- Drag `refapp.8xp` onto the calculator using the standard method with [TI Connect version 4](https://education.ti.com/en/software/details/en/B59F6C83468C4574ABFEE93D2BC3F807/swticonnectsoftware). Important: use version 4 for the TI-84 Plus.
- Drag `refapp.8xp` onto the calculator using the standard method with [TI Connect version 4](https://education.ti.com/en/software/details/en/B59F6C83468C4574ABFEE93D2BC3F807/swticonnectsoftware). Important: Use version 4 for the TI-84 Plus.
- The on-calculator name of the program is `REFAPP`.
- To start the program, use the usual `Asm(prgm)` option found in the `CATALOG` menu and select the `REFAPP` program.
- To exit the blinky _ON_/_OFF_ show, press the enter key.
Expand All @@ -60,9 +60,10 @@ C-runtime initialization (i.e., static initialization prior to the call of `main
is supported with the file [crt0.s](./src/startup/crt0.s) in the `startup` directory.

The build system:
- The build system uses GNUmake with a straighforward [Makefile](./build/Makefile).
- The build system is supported on both `Win*` and `*nix`. Ported `*nix` tools support the `Win*`-build.
- Build results including HEX-File and the on-calculator image `refapp.8xp` will be placed in the `bin`-directory.
- The build system uses GNUmake with a straighforward [`Makefile`](./build/Makefile).
- The build system is supported on both `Win*` and `*nix`.
- The `Win*`-build requires a small selection of ported `*nix` tools. These are included in the [`wbin`](./build/tools/UnxUtils/usr/local/wbin) directory.
- Build results including HEX-File and the on-calculator image `refapp.8xp` are placed in the `bin`-directory.

### Build on `Win*`

Expand Down Expand Up @@ -98,22 +99,22 @@ Continuous integration is performed on GHA using an ubuntu-latest runner.
The [workflow run](./.github/workflows/ti84-ref_app.yml)
builds the application and verifies the presence of `bin/refapp.8xp`.

## Aditional Information
## Aditional Details

### Origins (and Reservations)

Origins
- This project has been inspired by and influenced by numerous previous works, including (but not limited to) the [azertyfun/LibTI](https://github.com/azertyfun/LibTI) project.
- The aforementioned [project](https://github.com/azertyfun/LibTI) was ground-breaking and excellent.

Please do, however, use at your own discretion and observe also
the [license](./LICENSE) details.
the [license](./LICENSE) details. This project is not in any way
affiliated with Texas Instruments Inc, or any of its subsidiaries,
including the educational products division.

Some of this software has been reverse engineered
from other projects or terse technical notes.
In addition, the software actively writes to calculator
_ports_, such as port `0x40` and port `0x41`.

Personally. I do not consider this to be a $100\\%$ sound basis
for project reliability and/or stability.

Expand All @@ -123,9 +124,14 @@ It provides a basis that seems to adhere to the established,
common rules of modern C. Larger projects could be built or modelled
from this.

### References

- _TI_-_83_ _Plus_ _System_ Routines_ _Third_ Release_ (Jan. 25, 2002), located [here](https://education.ti.com/html/eguides/discontinued/computer-software/EN/SDK-TI-83-System-Routines_EN.pdf)
- _SDCC_ _Compiler_ _User_ _Guide_, SDCC 4.4.0, Revision 14549 (Dec. 20, 2023), located [here](https://sdcc.sourceforge.net/doc/sdccman.pdf)

### Licensing

- The source code written for this repo (in the [`src`](./src)) directory is licensed under [_The_ _Unlicense_](./LICENSE).
- `Win*` ported `*nix` tools (including `cp.exe`, `echo.exe`, `mkdir.exe`, `mv.exe` and `rm.exe`) originate from [UnxTools](https://sourceforge.net/projects/unxutils) and include their own [distribution statements](./build/tools/UnxUtils).
- The `Win*`-ported `objcopy.exe` originates from _nuwen_'s specially-built [standalone MinGW](https://nuwen.net/mingw.html).
- `Win*`-ported `*nix` tools in [`wbin`](./build/tools/UnxUtils/usr/local/wbin) originate from [UnxTools](https://sourceforge.net/projects/unxutils) and include their own [distribution statements](./build/tools/UnxUtils).
- The `Win*`-ported `objcopy.exe` originates from Steven T. Lavavej's [`MinGW Distro`](https://nuwen.net/mingw.html).
- The `Win*`-ported GNUmake is taken from [`ckormanyos/make-4.2.1-msvc-build`](https://github.com/ckormanyos/make-4.2.1-msvc-build).

0 comments on commit 1ea8c6a

Please sign in to comment.