From aca7e890a163398aa4256d48395f09fe5286424d Mon Sep 17 00:00:00 2001 From: Jackson Bailey Date: Mon, 8 Jul 2024 00:13:49 -0400 Subject: [PATCH] Update various documentation --- DEV_GUIDE.md | 5 +++++ README.md | 13 +++++++++++++ other/README.md | 3 ++- .../wheel/terra/service/EchoCommand.java | 3 +++ .../wheel/terra/service/ResetCommandsCommand.java | 5 +++++ 5 files changed, 28 insertions(+), 1 deletion(-) diff --git a/DEV_GUIDE.md b/DEV_GUIDE.md index 864531b..0b6dd77 100644 --- a/DEV_GUIDE.md +++ b/DEV_GUIDE.md @@ -60,3 +60,8 @@ You can drill down with `reason` on a specific project and dependency like so. ```shell ./gradlew :vexillum:vexillum-core:reason --id org.junit.jupiter:junit-jupiter-api ``` + +Planning future tasks +--------------------- + +This project uses `TODO` comments to indicate potential future tasks. diff --git a/README.md b/README.md index 179b877..cf3b96b 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,16 @@ Reinventing the wheel ===================== +Foreword +-------- + +This repository has become more of a monorepo for Java projects I want to fiddle around with than a +specific collection of "reinvented wheels." This makes it easy to just jump in and hack away without +wasting time on how to set up projects "correctly." Versioning seems annoying in monorepos, but I +also don't see myself actually *releasing* anything in the foreseeable future. I'll deal with that +when I get to it, if ever. I still plan to make notes about things I learn along the way and to make +detailed commit messages, so hopefully this is still a useful resource for folks. + Introduction ------------ @@ -57,8 +67,11 @@ Licensing As a whole this repository is licensed under [AGPL-3.0-or-later][agpl]. Each individual subproject may have different licenses. As an example, the collections project uses [LGPL-3.0-or-later][lgpl]. +See the `LICENSE` (and `LICENSE.LESSER` if present) file(s) for details. These should also be +included in jar files built by this project. [agpl]: https://www.gnu.org/licenses/agpl-3.0.txt + [lgpl]: https://www.gnu.org/licenses/lgpl-3.0.txt Development guide diff --git a/other/README.md b/other/README.md index bedf72f..c28dac4 100644 --- a/other/README.md +++ b/other/README.md @@ -2,7 +2,8 @@ ## Code style -This project uses a modified version of Google's Java Style. Import `GoogleStyle_customized.xml` +This project uses a modified version of Google's Java Style. These should be used automatically via +`.idea/codeStyles/Project.xml`. If that is not working then import `GoogleStyle_customized.xml` into IntelliJ to use it. The differences are below. (Or run `diff ./other/intellij-java-google-style.xml ./other/GoogleStyle_customized.xml` instead.) diff --git a/terra/src/main/java/dev/jacksonbailey/wheel/terra/service/EchoCommand.java b/terra/src/main/java/dev/jacksonbailey/wheel/terra/service/EchoCommand.java index 8d4f364..ac5efd2 100644 --- a/terra/src/main/java/dev/jacksonbailey/wheel/terra/service/EchoCommand.java +++ b/terra/src/main/java/dev/jacksonbailey/wheel/terra/service/EchoCommand.java @@ -10,6 +10,9 @@ import org.jetbrains.annotations.NotNull; import org.springframework.stereotype.Service; +/** + * Echos a phrase back to the user. This is really only for troubleshooting. + */ @Service public class EchoCommand extends AbstractCommand { diff --git a/terra/src/main/java/dev/jacksonbailey/wheel/terra/service/ResetCommandsCommand.java b/terra/src/main/java/dev/jacksonbailey/wheel/terra/service/ResetCommandsCommand.java index d75c82c..8e98920 100644 --- a/terra/src/main/java/dev/jacksonbailey/wheel/terra/service/ResetCommandsCommand.java +++ b/terra/src/main/java/dev/jacksonbailey/wheel/terra/service/ResetCommandsCommand.java @@ -8,6 +8,11 @@ import net.dv8tion.jda.api.utils.messages.MessageCreateData; import org.jetbrains.annotations.NotNull; +/** + * Resets all registered commands. Only for troubleshooting. In theory all commands should be + * updating when the application starts, but it seems like there may have been a delay or something. + * This is just in case. + */ public class ResetCommandsCommand extends AbstractCommand { public ResetCommandsCommand(JDA jda) {