Skip to content

Commit 6c28ca5

Browse files
committed
document better and run spotless in comment command
1 parent 0b2703d commit 6c28ca5

File tree

5 files changed

+20
-25
lines changed

5 files changed

+20
-25
lines changed

.editorconfig

Lines changed: 0 additions & 5 deletions
This file was deleted.

.github/workflows/comment-command.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,10 @@ jobs:
1919
comment_id: context.payload.comment.id,
2020
content: "rocket",
2121
});
22+
- uses: actions/setup-java@v4
23+
with:
24+
distribution: 'zulu'
25+
java-version: 17
2226
- uses: actions/checkout@v4
2327
with:
2428
fetch-depth: 0
@@ -41,6 +45,8 @@ jobs:
4145
run: pip3 install wpiformat
4246
- name: Run wpiformat
4347
run: wpiformat
48+
- name: Run Spotless
49+
run: ./gradlew spotlessApply
4450
- name: Commit
4551
run: |
4652
# Set credentials

README.md

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -10,18 +10,6 @@ Fork this repository then open up a terminal and run :
1010
```bash
1111
git clone https://github.com/*yourusernamehere*/2024-Crescendo.git
1212
cd 2024-Crescendo
13-
chmod +x init.sh
14-
./init.sh
15-
```
16-
Now look in [CONTRIBUTING.md](./CONTRIBUTING.md) before continuing!
17-
18-
Windows
19-
---
20-
Fork this repository then open up a terminal and run :
21-
```powershell
22-
git clone https:\\github.com\*yourusernamehere*\2024-Crescendo.git
23-
cd 2024-Crescendo
24-
.\init
2513
```
2614
Now look in [CONTRIBUTING.md](./CONTRIBUTING.md) before continuing!
2715

@@ -48,7 +36,7 @@ Clean
4836
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.
4937

5038
Simulation
51-
----------
39+
---
5240
**Release**
5341
`./gradlew :simulateNative`
5442
Runs a simulation of your code at highest optimisation.
@@ -57,6 +45,19 @@ Runs a simulation of your code at highest optimisation.
5745
`./gradlew :simulateNativeDebug`
5846
Runs a debug simulation of your code, including a variety of debugging tools similar to glass but at lower optimisation.
5947

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+
6061
Documentation
6162
=============
6263
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.

init.ps1

Lines changed: 0 additions & 2 deletions
This file was deleted.

init.sh

Lines changed: 0 additions & 5 deletions
This file was deleted.

0 commit comments

Comments
 (0)