Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
SnorlaxAssist authored Mar 27, 2024
1 parent 3266b66 commit b9b9177
Showing 1 changed file with 10 additions and 3 deletions.
13 changes: 10 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,9 +72,16 @@ The Luau VM provides simple hooks to see into the VM at certain points, the Fiu

# Contributing

- Tests can be added and compiled using CreateTests.lua, Lua with the `io` and `os` library is needed.
- Tests must be ran with Luau using `RunTests.lua`, you can use `allTests` or `specificTests`.
- Contributed code should be consistent with the source.
- Testing using GitHub Actions
- Fork this repository, and commit your changes.
- Commiting changes should automatically run tests with `GitHub Actions`.
- Results would show for the commit.
- Testing locally(optional)
- `fiu-tests` must be compiled using CMake, this is needed to run and debug tests.
- Setup cmake tree with `cmake ./tests` or `cmake -DCMAKE_BUILD_TYPE=Release ./tests` for release tree.
- Compile cmake tree with `cmake --build . --target=fiu-tests`.
- Tests must be ran with `fiu-tests` executable compiled from cmake.
- For specific test use `-t <file path>` or test the whole directory with `-tf <directory path>`, the paths are relative to `(workspaceRoot)/tests/`.

<div>Luau updates often and Fiu will need to be updated and have working releases added for every new bytecode version.</div>

Expand Down

0 comments on commit b9b9177

Please sign in to comment.