yobemag

Requirements

• GNU C17
• SDL2 (on debian-based systems: libsdl2-dev)
• Criterion test suite for unit tests (on debian-based systems: libcriterion-dev)

Build

rm -rf build
mkdir build && cd build
cmake -DCMAKE_BUILD_TYPE=RELEASE -DOPTIMIZE=3 -DCMAKE_C_COMPILER=<gcc|clang> ..
make

CMake Options

Use these options with -D<Option>=<Value>.

Option	Values	Explanation	Requires
CMAKE_BUILD_TYPE	DEBUG,RELEASE	DEBUG adds the -g compiler flag and the YOBEMAG_DEBUG compile definition	-
OPTIMIZE	0, 1, 2, 3, fast, s, z, g	See, e.g., GCC optimization options	Compiler support
CMAKE_C_COMPILER	Supported: gcc (11), clang (11, 12, 13, 14)	The supported versions are used by our pipeline and guarantee compatibility	-
TEST	0, 1	Disables/Enables building tests	-
COVERAGE	0, 1	Removes/Adds instrumentation required for coverage reports	TEST=1
SANITIZE	gcc: valgrind, clang: address, memory, undefined	valgrind: runs the executable with valgrind. address, memory, undefined: instrument the executable with sanitizers	clang OR gcc

Build Targets

Use these targets with make <Target>

Target	Explanation
	Default target, builds the yobemag executable
test	Builds the yobemag_test executable that runs unit tests from test/
sanitize	Runs yobemag or yobemag_test (depending on TEST=<0/1>) with the specified sanitizer (see SANITIZE)
install	Builds the default target and copies it to ~/.local/bin/yobemag. You can uninstall by just removing the binary.

Test

rm -rf build
mkdir build && cd build
cmake -DTEST=1 -DCMAKE_BUILD_TYPE=DEBUG -DOPTIMIZE=3 -DCMAKE_C_COMPILER=<gcc|clang> ..
make test

Run yobemag

yobemag [-l <0..4>] <ROM_PATH>

Arguments	Required	Explanation
-l	no	Set the log level
ROM_PATH	yes	Provide relative path (w.r.t. executable) or absolute path to rom

Contributing

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature-<cool-feature-name>)
3. Implement your desired Feature!
4. Add your Files to the Staging Area (git add <your-files>)
5. Commit your Changes (git commit -m 'feat: add some cool feature description here!')
6. Push to the Branch (git push origin feature-<cool-feature-name>)
7. Create a new Pull Request

Pre-commit hooks

We strongly encourage you to install pre-commit hooks that make sure your commit is clean. The hook runs the following things:

• YAML lint
• new line at EOF check
• merge conflict check
• clang-format (in-place)

You can install the hook as follows:

pip install pre-commit
pre-commit install