Skip to content

Commit

Permalink
CONTRIBUTING: Include note about building modules for test suite
Browse files Browse the repository at this point in the history
Before running the test suite, the console module at the very least
needs to be compiled. This adds a note about building the modules before
running the test suite.

Additionally, I updated the path for the ArkScript test suite (the
correct path is `tests/arkscript/unittests.ark`).

I've also updated the name of the executable to be `arkscript` so users
do not get the deprecation warning when copying/pasting the command.


Former-commit-id: 835cf7e974ecfc03ca9f427abbe0e9230d1046ba
  • Loading branch information
rstefanic committed Feb 9, 2022
1 parent 01f7a18 commit 2d971ac
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,9 +48,9 @@ run-on .\src

### Running the test suite

ArkScript test suite should be ran from the root folder and the console module should have been compiled (it is used for colors). You can then run `./build/ark tests/arkscripts/unittests.ark --lib ./lib`.
The ArkScript test suite requires the console module for text colors. You can build all the modules by including the `-DARK_BUILD_MODULES` CMake switch when building ArkScript. Once you have the modules built, you can run the ArkScript test suite from the root folder using `./build/arkscript tests/arkscript/unittests.ark --lib ./lib`.

The standard library test suite should be ran from the root folder of the project (the console module needs to be copied to the folder). You can then run `./ark tests/all.ark --lib ./`.
The standard library test suite should be ran from the root folder of the standard library project (the console module will need to be copied to the folder). You can run standard library test suite using `./arkscript tests/all.ark --lib ./`.

## C++ coding guidelines

Expand Down

0 comments on commit 2d971ac

Please sign in to comment.