Skip to content

Commit

Permalink
Merge branch 'readme' into libcheck_unit_tests
Browse files Browse the repository at this point in the history
  • Loading branch information
jc-SpaceXp committed Dec 11, 2024
2 parents bcaf35c + 0b2cc8c commit b10a9cc
Showing 1 changed file with 6 additions and 7 deletions.
13 changes: 6 additions & 7 deletions readme.org
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,13 @@ that I'm proud of!

** Building cNES

cNES supports multiple OSes via cmake or can be built using make on Linux. I
cNES supports multiple OSes via CMake or can be built using Make on Linux. I
primarily develop on Linux however cNES can be ported over to other
platforms via cmake.
platforms via CMake.

*Prerequisites:*
- cmake (or make for older builds)
- [[https://gcc.gnu.org/][gcc]] or [[https://clang.llvm.org/][clang]] compilers (or any compiler supported by cmake)
- CMake (or Make for older builds) (with CMake SDL and libcheck can be downloaded and built from source if not present on your machine)
- [[https://gcc.gnu.org/][gcc]] or [[https://clang.llvm.org/][clang]] compilers (or any compiler supported by CMake)
- gcc versions >= 4.8 or clang versions >= 3.1 are required to use the address sanitizer compile option ([[https://github.com/google/sanitizers/wiki/AddressSanitizer][ASan]])
- [[https://libcheck.github.io/check/][libcheck]] (currently unit tests are always run when compiling cNES)
- [[https://wiki.libsdl.org/SDL2/Introduction][SDL2]]
Expand Down Expand Up @@ -63,11 +63,10 @@ $ make CC=clang
$ make CC=clang DEBUG=1 ASAN=1
#+END_EXAMPLE

For cmake: the compiled binary will either end up in =./build/<PRESET_NAME>=
For CMake: the compiled binary will end up in =./build/<PRESET_NAME>=


For make: the compiled binary will either end up in =./build/release/bin/=
or =./build/debug/bin/=
For Make: the compiled binary will either end up in =./build/release/bin/= or =./build/debug/bin/=

** Running cNES

Expand Down

0 comments on commit b10a9cc

Please sign in to comment.