Skip to content

Commit

Permalink
Update various documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
JacksonBailey committed Jul 8, 2024
1 parent 3bd6cae commit aca7e89
Show file tree
Hide file tree
Showing 5 changed files with 28 additions and 1 deletion.
5 changes: 5 additions & 0 deletions DEV_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
------------

Expand Down Expand Up @@ -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
Expand Down
3 changes: 2 additions & 1 deletion other/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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) {
Expand Down

0 comments on commit aca7e89

Please sign in to comment.