Skip to content

Commit b7c1cc0

Browse files
authored
Cleanup README (#392)
The README has gotten quite bloated and needed to be cleaned up. Contributing information is moved to `CONTRIBUTING.md`, usage info is in `USAGE.md`, and the `README.md` is now much easier to read and follow.
1 parent 3570d20 commit b7c1cc0

File tree

3 files changed

+330
-253
lines changed

3 files changed

+330
-253
lines changed

CONTRIBUTING.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Contributing to AnvilGUI
2+
3+
The project uses the Maven. Run `mvn clean install` using Java 21 to build the project.
4+
5+
## Formatting
6+
7+
The project uses the [Spotless Maven Plugin](https://github.com/diffplug/spotless/tree/main/plugin-maven) to
8+
enforce style guidelines. You will not be able to build the project if your code does not meet the guidelines.
9+
To fix all code formatting issues, run `mvn spotless:apply`.
10+
11+
## Deployment
12+
13+
The code is built and deployed to `mvn.wesjd.net` via GH actions whenever a push to `master` occurs.

0 commit comments

Comments
 (0)