From ccf16dd970d9b7c0ba256b70787c9ba5f491831f Mon Sep 17 00:00:00 2001 From: Peter Evans Date: Fri, 8 Dec 2017 22:34:09 -0600 Subject: [PATCH] Documented some goals for the project --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index cb78670..4e3124c 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,18 @@ Erc is software that allows you to emulate computers from the days of yore. (The Erc is also a sound you might make when feeling slightly frustrated, or if you were a small cat that happens to make funny sounds that aren't quite meows. +## Goals + +I've long had an interest in retro computing, collecting books on the 6502 processor in particular, and this program has been written and rewritten in fits and starts over several years (and in several languages!). Being able to emulate the Apple II, which was my childhood computer, has been a dream of mine for some time! + +Erc is written in C, largely because I have long loved that language, though I have not had much need to use it in my professional career. C is a somewhat cranky language, and not one that lends itself to modern engineering practices, so erc was partly written as a challenge to myself to try and elevate the language. + +In particular, it's a goal of mine to ensure that erc: + +* is written for other developers to read, especially as a reference for those who are interested in emulation in general and the platforms emulated here in particular; +* is modular, allowing as much code reuse within the application as is practical; +* is unit-testable, to the extent that C allows, and maintains a high level of code coverage. + ## Running Right now, erc is mostly unusable; large components of it are still being built out. However, if you do run it, you will see a string that reads: