You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Now look in [CONTRIBUTING.md](./CONTRIBUTING.md) before continuing!
27
15
@@ -48,7 +36,7 @@ Clean
48
36
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.
49
37
50
38
Simulation
51
-
----------
39
+
---
52
40
**Release**
53
41
`./gradlew :simulateNative`
54
42
Runs a simulation of your code at highest optimisation.
@@ -57,6 +45,19 @@ Runs a simulation of your code at highest optimisation.
57
45
`./gradlew :simulateNativeDebug`
58
46
Runs a debug simulation of your code, including a variety of debugging tools similar to glass but at lower optimisation.
59
47
48
+
Formatting
49
+
---
50
+
**Check**
51
+
`./gradlew spotlessCheck`
52
+
Checks the formatting of build and miscellaneous files, NOT source files.
53
+
54
+
**Apply**
55
+
`./gradlew spotlessApply`
56
+
Applies formatting to build and miscellaneous files, NOT source files.
57
+
58
+
`wpiformat`
59
+
Relies on you having wpiformat installed. Formats source files.
60
+
60
61
Documentation
61
62
=============
62
63
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 commit comments