erc

command module
v0.0.0-...-48aa4a7 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 29, 2024 License: MIT Imports: 16 Imported by: 0

README

erc

The erc (emulator of retro computers) system is designed to emulate an Apple IIe (enhanced) computer and run software for it. It is written to be flexible enough to handle multiple machine architectures, and may be extended to do just that in the future.

It's a rewrite of an older project (https://github.com/pevans/erc-c), by the same name, that was written in C code. This project is instead written in Go, which has much better tooling for code formatting and testing--something that I felt was lacking in the previous iteration. I also just really like Go! I regret nothing.

The soul of the work here, which is emulation of the Apple II, has been a hobby of mine going back more than a decade. I am enormously grateful to Rodney Zaks for his book Programming the 6502, Jim Sather for his work Understanding the Apple II, Apple--beyond building the machine, they published a wealth of technical reference material for it--and, of course, Steve Wozniak, without whom the Apple II and Apple-as-we-know-it would not exist.

What's in here?

  • The main command (erc) is located in this directory (erc.go).
  • Code for the MOS 65c02 processor is in mos65c02.
  • Code for the Apple II architecture is in a2.
  • There's random other code for things generally within other subdirectories.

What can I do here?

You can:

  • Build the executable erc by running go build.
  • Run various tests, including:
    • task lint for linting (requires Task)
    • go test ./... for unit tests

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
a2
a2enc
a2enc provides code to encode logically formatted disk images into a physical format, or vice versa, decode physically formatted images to a logical format.
a2enc provides code to encode logically formatted disk images into a physical format, or vice versa, decode physically formatted images to a logical format.
a2font
a2font provides fonts that can be used for the Apple II.
a2font provides fonts that can be used for the Apple II.
a2state
a2state provides a set of consts that you can use to reference state in the Apple II.
a2state provides a set of consts that you can use to reference state in the Apple II.
a2sym
a2sym provides symbols that are used or define in Apple II technical literature.
a2sym provides symbols that are used or define in Apple II technical literature.
a2video
a2video provides functionality to render graphics for an Apple II computer.
a2video provides functionality to render graphics for an Apple II computer.
internal

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL