Skip to content

Latest commit

 

History

History
92 lines (77 loc) · 3.4 KB

README.md

File metadata and controls

92 lines (77 loc) · 3.4 KB

YaNES

A Semi Cycle Accurate NES Emulator      Build Status   GitHub issues   GitHub license   GitHub stars  

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

QT is needed to run YaNES
Boost libraries are only required to run the tests.
The microprocessor and picture proccessing unit by itself does not require any external libraries, however
YaNES does require a C++14 compiler

Installing Prerequisites - QT

Qt can either be installed through Qt's website installer located here or by installing by the command line.
Installing through command line:

sudo apt install qtbase5-dev qtdeclarative5-dev
sudo apt install qt5-default qttools5-dev-tools
sudo apt install qtmultimedia5-dev

Depending on the installation, Qmake will need to be configured this is done by:

export QMAKE=/usr/lib/x86_64-linux-gnu/qt5/bin/qmake

Installing Prerequisites - Boost Libraries

YaNES makes use of Boost.Test and Boost.Program_Options

sudo apt install libboost-dev
sudo apt install libboost-program-options-dev

Installing - Getting a development environment running

Either download and unzip this repository via the top right or by cloning the repository first:

git clone https://github.com/Grandduchy/YaNES
cd YaNES

Use Qmake and Make to create the executable

qmake
make

Depending on the configuration, add executable permissions to the executable app, and run

chmod +x app
./app

Running the tests

Refer to YaNES/test/README.md

Built With

Authors

  • Joshua Challenger - Complete Project - Grandduchy

License

This project is licensed under the MIT License - see the LICENSE file for details

Acknowledgments and Sources

A ton of sources were used to create this project
Below are the main ones used.