Skip to content

Commit

Permalink
add some more details
Browse files Browse the repository at this point in the history
  • Loading branch information
spacey-sooty committed Dec 27, 2023
1 parent 9d87ec9 commit 88065db
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,3 +50,16 @@ Clean
`./gradlew clean`
Cleaning removes caches of your compiled code. If you do not understand an error it can often help to clean before getting help. Clean building is slower so you should not generally use it.

Simulation
----------
**Release**
`./gradlew :nativeSimulation`
Runs a simulation of your code at highest optimisation.

**Debug**
`./gradlew :nativeSimulationDebug`
Runs a debug simulation of your code, including a variety of debugging tools similar to glass but at lower optimisation.

Documentation
=============
Our documentation for Wombat and each years codebase can be found [here](https://4788-docs.vercel.app/). It is a powerful reference for writing code using Wombat going over how to use and the implementation for everything within Wombat. It also has a variety of guides to teach you how to use a variety of things in a more tutorial style way.

0 comments on commit 88065db

Please sign in to comment.