6502/erc-c
1
0
Fork 0
mirror of https://github.com/pevans/erc-c.git synced 2024-11-27 05:49:24 +00:00
Code Issues Projects Releases Wiki Activity

Add the name of the software

Browse Source
This commit is contained in:
Peter Evans 2017-12-05 18:38:14 -06:00
parent fc4a6f19e6
commit 913297addd
1 changed files with 34 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
README.md
View File

@ -1,6 +1,34 @@
# 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. Do this:
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](https://brew.sh/) 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
@ -20,4 +48,8 @@ cmake ..
make; ./emp-test
```
This will execute the testing build of the software, which is handled through [Criterion](https://github.com/Snaipe/Criterion). Note you must have already installed Criterion for this to work.
This will execute the testing build of the software, which is handled through [Criterion](https://github.com/Snaipe/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.