From d68bf1c7b51e0d6335f9439818e6effd5f9ae501 Mon Sep 17 00:00:00 2001
From: ILikePlayingGames <22475143+ILikePlayingGames@users.noreply.github.com>
Date: Wed, 31 Jul 2024 06:55:08 -0400
Subject: Various build script improvements (#6)

- Add DevAuth for logging into online mode servers (disabled by default)
- Fill in mod version during build in ForgeModAPI.java
- Fix gradle running out of memory during `gradlew setupDecompWorkspace`
- Add some development tips to README.md
- Change logging to log4j in ForgeModAPI.java
---
 README.md | 11 ++++++++++-
 1 file changed, 10 insertions(+), 1 deletion(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index b309cd8..bf922d2 100644
--- a/README.md
+++ b/README.md
@@ -5,4 +5,13 @@ This repository contains the implementation of the Hypixel Mod API for the Froge
 
 ## Contributing
 
-If you wish to contribute to this implementation of the Mod API to offer improvements or fixes, you can do so by forking the repository and creating a pull request.
\ No newline at end of file
+If you wish to contribute to this implementation of the Mod API to offer improvements or fixes, you can do so by forking the repository and creating a pull request.
+
+> [!IMPORTANT]  
+> Run `gradlew setupDecompWorkspace` after importing the project to generate the files required to build it
+
+If IntelliJ still shows unknown symbol errors after running the command, you may need to [clear the filesystem cache](https://www.jetbrains.com/help/idea/invalidate-caches.html).
+
+### Testing Your Changes
+
+You can enable DevAuth to log in to the Hypixel server with your Minecraft account. Please see the [DevAuth docs](https://github.com/DJtheRedstoner/DevAuth) for more details.
\ No newline at end of file
-- 
cgit