Skip to content

Commit

Permalink
document better and run spotless in comment command
Browse files Browse the repository at this point in the history
  • Loading branch information
spacey-sooty committed Mar 9, 2024
1 parent b99e021 commit 454f949
Show file tree
Hide file tree
Showing 5 changed files with 20 additions and 25 deletions.
5 changes: 0 additions & 5 deletions .editorconfig

This file was deleted.

6 changes: 6 additions & 0 deletions .github/workflows/comment-command.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,10 @@ jobs:
comment_id: context.payload.comment.id,
content: "rocket",
});
- uses: actions/setup-java@v4
with:
distribution: 'zulu'
java-version: 17
- uses: actions/checkout@v4
with:
fetch-depth: 0
Expand All @@ -41,6 +45,8 @@ jobs:
run: pip3 install wpiformat
- name: Run wpiformat
run: wpiformat
- name: Run Spotless
run: ./gradlew spotlessApply
- name: Commit
run: |
# Set credentials
Expand Down
27 changes: 14 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,18 +10,6 @@ Fork this repository then open up a terminal and run :
```bash
git clone https://github.com/*yourusernamehere*/2024-Crescendo.git
cd 2024-Crescendo
chmod +x init.sh
./init.sh
```
Now look in [CONTRIBUTING.md](./CONTRIBUTING.md) before continuing!

Windows
---
Fork this repository then open up a terminal and run :
```powershell
git clone https:\\github.com\*yourusernamehere*\2024-Crescendo.git
cd 2024-Crescendo
.\init
```
Now look in [CONTRIBUTING.md](./CONTRIBUTING.md) before continuing!

Expand All @@ -48,7 +36,7 @@ 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 :simulateNative`
Runs a simulation of your code at highest optimisation.
Expand All @@ -57,6 +45,19 @@ Runs a simulation of your code at highest optimisation.
`./gradlew :simulateNativeDebug`
Runs a debug simulation of your code, including a variety of debugging tools similar to glass but at lower optimisation.

Formatting
---
**Check**
`./gradlew spotlessCheck`
Checks the formatting of build and miscellaneous files, NOT source files.

**Apply**
`./gradlew spotlessApply`
Applies formatting to build and miscellaneous files, NOT source files.

`wpiformat`
Relies on you having wpiformat installed. Formats source files.

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.
2 changes: 0 additions & 2 deletions init.ps1

This file was deleted.

5 changes: 0 additions & 5 deletions init.sh

This file was deleted.

0 comments on commit 454f949

Please sign in to comment.