Update 'README.md'

This commit is contained in:
Trianta 2023-10-23 12:12:32 -05:00
parent 94d30f6d91
commit e87d778903

View File

@ -11,20 +11,24 @@ In order to compile the project, simply run these two commands:
cmake --build build cmake --build build
## Running the Project ## Running the Project
The program should now be compiled at ./build/bin/something
The program should now be compiled at build/bin/something
Simply run the program using: Simply run the program using:
build/bin/something build/bin/something
## Testing the Project ## Testing the Project
Prerequisites
- Unity (Throw the Switch) | [AUR](https://aur.archlinux.org/packages/unity-test)
In order to compile the tests for the project, simply run these two commands: In order to compile the tests for the project, simply run these two commands:
cmake -DCMAKE_BUILD_TYPE=Debug -B build -S . cmake -DCMAKE_BUILD_TYPE=Debug -B build -S .
cmake --build build cmake --build build
The program should now be compiled at ./build/bin/somethingTest The program should now be compiled at build/bin/tests
Simply run the tests using: Simply run the tests using:
build/bin/somethingTest build/bin/tests