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

Baby's first README

Browse Source
This commit is contained in:
Peter Evans 2017-12-04 23:31:05 -06:00
parent 54473be302
commit fc4a6f19e6
1 changed files with 23 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.md Normal file
View File

@ -0,0 +1,23 @@
## 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:
```
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; ./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.