6502/erc-c

mirror of https://github.com/pevans/erc-c.git synced 2024-11-27 05:49:24 +00:00

An emulator for old / retro computers

Go to file

Peter Evans ea2b68dc8c Documentation, and reorganizing macro definitions		2017-12-06 21:29:03 -06:00
build	First commit	2017-11-21 23:24:51 -06:00
include	Documentation, and reorganizing macro definitions	2017-12-06 21:29:03 -06:00
src	Documentation, lacking	2017-12-06 21:25:47 -06:00
tests	We have to pass NULL into log_open now	2017-12-06 16:53:15 -06:00
.gitignore	First commit	2017-11-21 23:24:51 -06:00
CMakeLists.txt	It's erc, not emp	2017-12-06 16:07:36 -06:00
LICENSE	Use the MIT license	2017-12-06 17:08:09 -06:00
README.md	Erc, not emp	2017-12-06 16:11:13 -06:00
sources.cmake	It's erc, not emp	2017-12-06 16:07:36 -06:00

README.md

erc

(Emulator of old, Retro Computers)

Erc is software that allows you to emulate computers from the days of yore. (The "days of yore" may be defined as the 1980s.) You may find it interesting if you feel nostalgia for those old machines, or if you want to see how those computers worked.

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.

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:

Hello, world!

In and of itself, this is not so bad, as the software is at least cheerful. If you were having a bad day, seeing "Hello, world!" might make you feel a little bit better.

Compiling and installing

This software uses CMake to build its makefiles, so if you're familiar with that, you should feel somewhat at home.

If you've never compiled any C code before, you will need to install a few things first. If you have not done so, you should install the excellent Homebrew if using a Mac. If you are using Linux, you are probably already acquainted with your local package manager. You will also need to have XCode installed in a Mac environment. You can do so through the App Store.

The following other things you must install are given as Homebrew commands. If you are using Linux, I will leave the appropriate commands you must run as an exercise for the reader.

brew install cmake
brew install snaipe/soft/criterion

Once all that is accomplished, you can do this:

cd build
cmake ..
make

This should produce an executable of the emulator, which you can install wherever you wish.

Testing

If you're feeling a bit nosy, you can run unit tests by doing the following:

cd tests/build
cmake ..
make; ./erc-test

This will execute the testing build of the software, which is handled through Criterion.

Contributing

Right now, I am not accepting pull requests as so much of the design of erc is in flux. I am happy to receive any issues you may file.