krgamestudios/Toy
1
0
Fork 0
mirror of https://github.com/krgamestudios/Toy.git synced 2026-04-15 06:44:07 +10:00
Code Issues Packages Projects Releases Wiki Activity

Updated docs and comments

Browse Source
This commit is contained in:
Kayne Ruse
2024-12-11 17:07:49 +11:00
parent 476a79b746
commit 5f4dfdccc5
7 changed files with 74 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
tests/README.md
View File

@@ -1,30 +1,22 @@
# Test Instructions
To run these tests, execute the following commands from the repo's root:
To run these tests, execute one of the following commands from the repo's root:
`make tests`
`make test-cases`
`make test-integrations`
Alternatively, to run these tests under GDB, execute the following commands from the repo's root:
`make tests-gdb`
`make test-cases-gdb`
`make test-integrations-gdb`
Remember that `make clean` will remove the build artifacts after testing, and `make tests` and `make-tests-gdb` automatically invoke `make clean` before they begin.
`make tests-valgrind`
## Benchmarks
For testing and comparing different potential solutions. This may be left in an incomplete state, so it might not work out of the box.
For testing and comparing different potential solutions. These may be left in an incomplete state, so they might not work out of the box.
## Cases
For testing individual pieces of the source code in isolation. These are essentially the unit tests.
For testing individual pieces of the source code in isolation. These are essentially the unit tests, and are used by the CI pipeline.
## Integrations
This compiles the source and repl files into a library and executable, then runs each `*.toy` file through the repl to ensure the Toy code works in practice. These are essentially integration tests.
For testing Toy's processes as a complete whole. This will automatically build the repl, and is used by the CI pipeline.
## Mustfails