generated from Foulest/JavaTemplate
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
16 additions
and
20 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,34 +1,30 @@ | ||
| # Java Template | ||
| # Swiss | ||
|
|
||
| [](LICENSE) | ||
| [](https://github.com/Foulest/JavaTemplate/actions/workflows/github-code-scanning/codeql) | ||
| [](https://github.com/Foulest/Swiss/actions/workflows/github-code-scanning/codeql) | ||
|
|
||
| This is the template repository that I use for all of my Java projects. | ||
| **Swiss** is a Monte Carlo bracket simulator for Counter-Strike 2 tournaments. | ||
|
|
||
| ## Features | ||
|
|
||
| - Templates for pull requests, bugs, improvements, features, and questions | ||
| - Code of Conduct, Contributing, and Security guidelines | ||
| - GitHub Actions for building, dependency checking, and code scanning | ||
| - Gradle build system with Shadow plugin for creating shaded JARs | ||
| - Lombok and JetBrains Annotations dependencies for cleaner code | ||
| - Ability to simulate millions of brackets in seconds | ||
| - Both single and triple elimination brackets are available | ||
| - **100%** accurate seedings based | ||
| on [Buchholz](https://liquipedia.net/counterstrike/PGL/2024/Copenhagen/Europe_A#:~:text=The-,Buchholz%20system,-is%20used%20to) | ||
| and current standings | ||
| - Odds calculated using world rankings and average player ratings | ||
| - Customizable settings and detailed results for each bracket | ||
| - Easy-to-use console interface for quick bracket simulations | ||
| - Option to display odds for any manually given match | ||
|
|
||
| ## How to Use | ||
|
|
||
| 1. Clone the repository. | ||
| 2. Open the project in your favorite IDE (preferably [IntelliJ IDEA](https://jetbrains.com/idea)). | ||
| 3. Modify the project to your liking using the `TODO` comments. | ||
| 4. Build the project using `build`, `jar`, or `shadowJar`. | ||
| 5. Enjoy the template! | ||
|
|
||
| ## Things to Change | ||
|
|
||
| - [ ] Change the `README.md` file to your own project information. | ||
| - [ ] Change the `LICENSE` file to your own license (default is GPL v3). | ||
| - [ ] Change the issue templates and labels in the `.github/ISSUE_TEMPLATE` directory. | ||
| - [ ] Remove the `shadow` plugin from the `build.gradle` file if you don't want to use it. | ||
| - [ ] Remove the pre-existing dependencies from the `build.gradle` file if you don't want to use them. | ||
| 3. Run the `Swiss` class in the `src/main/java` directory. | ||
| 4. Follow the instructions in the console to simulate a bracket. | ||
| 5. View the results in the console. | ||
|
|
||
| ## Getting Help | ||
|
|
||
| For support or queries, please open an issue in the [Issues section](https://github.com/Foulest/JavaTemplate/issues). | ||
| For support or queries, please open an issue in the [Issues section](https://github.com/Foulest/Swiss/issues). |