Quick readme, only include gtest when testing is enabled.

2026-09-19 11:51:24 +02:00
parent 7b7fc0b17e
commit b5ae3805b0
3 changed files with 55 additions and 3 deletions
@@ -0,0 +1,40 @@
+# Juice Boy
+
+This is my first attempt at writing an emulator of any kind. It's mostly for me to learn about emulation.
+
+This project is written in `C++23` and uses `CMake` and `vcpkg`.
+
+## Building
+
+These steps describe the intended way of building. It should, however, be possible to not use presets or vcpkg to build.
+
+### Prerequisites
+
+- A build system that [can be generated](https://cmake.org/cmake/help/latest/manual/cmake-generators.7.html#id9)
+  with [CMake](https://cmake.org/).
+- A `C++23` compatible compiler.
+- [vcpkg](https://vcpkg.io/en/) installed and
+  `VCPKG_ROOT` [environment variable set](https://learn.microsoft.com/en-us/vcpkg/get_started/get-started?pivots=shell-bash).
+
+### Configure & Compile
+
+Most IDEs should pick up on the CMakePresets.json file and be able to do everything for you.
+
+If you want to manually generate and build without an IDE, you can still use the presets:
+
+```
+cmake --preset debug
+cmake --build --preset debug
+```
+
+There will be more presets for most platforms in the future.
+
+## Testing
+
+Eventually testing against test ROMs would be ideal, but until then you can run the unit tests.
+
+```
+ctest --build-dir <build dir>
+```
+
+Disable building tests by setting `ENABLE_TESTING` to `OFF`.