Update the ReadMe

Readme.md

@@ -5,8 +5,8 @@
 
 # What is Distant Horizons?
 
-This mod adds a Level Of Detail (LOD) system to Minecraft.\
+Distant Horizons is a Minecraft mod that adds a Level Of Detail (LOD) system to\
-This implementation renders simplified chunks outside the normal render distance\
+render simplified chunks outside the normal render distance\
 allowing for an increased view distance without harming performance.
 
 In other words: this mod lets you see farther without turning your game into a slide show.\
@@ -16,47 +16,42 @@ If you want to see a quick demo, check out a video covering the mod here:
 
 <br>
 
-## Mod and Library Versions
+## Minecraft and Library Versions
 
 This branch supports the following versions of Minecraft:
 
 #### 1.19 (WIP)
-Supported MC versions: [1.19]\
+Forge: 41.0.19\
-Forge version: 41.0.19\
+Fabric: 0.14.7\
-Fabric version: 0.14.7\
+Fabric API: 0.55.3+1.19\
-Fabric API version: 0.55.3+1.19\
+Modmenu: 4.0.0
-Modmenu version: 4.0.0
 
 #### 1.18.2
-Supported MC versions: [1.18.2]\
+Forge: 40.0.18\
-Forge version: 40.0.18\
+Fabric: 0.13.3\
-Fabric version: 0.13.3\
+Fabric API: 0.48.0+1.18.2\
-Fabric API version: 0.48.0+1.18.2\
+Modmenu: 3.1.0
-Modmenu version: 3.1.0
 
-#### 1.18.1
+#### 1.18.1, 1.18
-Supported MC versions: [1.18.1, 1.18]\
+Forge: 39.1.2\
-Forge version: 39.1.2\
+Fabric: 0.13.3\
-Fabric version: 0.13.3\
+Fabric API: 0.42.6+1.18\
-Fabric API version: 0.42.6+1.18\
+Modmenu: 3.0.1
-Modmenu version: 3.0.1
 
-#### 1.17.1
+#### 1.17.1, 1.17
-Supported MC versions: [1.17.1, 1.17]\
+Forge: 37.1.1\
-Forge version: 37.1.1\
+Fabric: 0.13.2\
-Fabric version: 0.13.2\
+Fabric API: 0.46.1+1.17\
-Fabric API version: 0.46.1+1.17\
+Modmenu: 2.0.14
-Modmenu version: 2.0.14
 
-#### 1.16.5
+#### 1.16.5, 1.16.5
-Supported MC versions: [1.16.5, 1.16.4]\
+Forge: 36.2.28\
-Forge version: 36.2.28\
+Fabric: 0.13.2\
-Fabric vetsion: 0.13.2\
+Fabric API: 0.42.0+1.16\
-Fabric API version: 0.42.0+1.16\
+Modmenu: 1.16.22
-Modmenu version: 1.16.22
 <br><br>
 
-#### Plugin and Library versions
+### Plugin and Library versions
 
 Architectury version: 3.4-SNAPSHOT\
 Architectury loom version: 0.12.0-SNAPSHOT\
@@ -85,31 +80,35 @@ Java Compiler plugin: Manifold Preprocessor
 3. Make sure eclipse has the JDK 17 installed. (This is needed so that eclipse can run minecraft)
 4. Import the project into eclipse
 
+
+
 ## Switching Versions
 
-To switch between active versions, change `mcVer=1.?` in `gradle.properties` file.
+To switch between different Minecraft versions, change `mcVer=1.?` in the `gradle.properties` file.
 
-If running in an IDE, to ensure the IDE noticed the version change, run a gradle command to prompt gradle into updating the libs. (In IntellJ you will also need to do a gradle sync if it didn't happen automatically.)
+If running in an IDE, to ensure the IDE noticed the version change, run any gradle command to refresh gradle. (In IntellJ you will also need to do a gradle sync if it didn't happen automatically.)
->Note: There may be a `java.nio.file.FileSystemException` thrown when running the command after switching versions. To fix it, either restart your IDE (as your IDE is locking up a file) or use a tool like LockHunter to unlock the linked file(s). (Generally it is a lib file under `common\build\lib`, `forge\build\lib`, or `fabric\build\lib`). If anyone knows how to solve this issue please write a comment on this issue: https://gitlab.com/jeseibel/minecraft-lod-mod/-/issues/233
+>Note: There may be a `java.nio.file.FileSystemException` thrown when running the command after switching versions. To fix it, either restart your IDE (as your IDE is probably locking a file) or use a tool like LockHunter to unlock the linked file(s). (Generally it is a lib file under `common\build\lib`, `forge\build\lib`, or `fabric\build\lib`). \
+> If anyone knows how to solve this issue please let us know here: \
+> https://gitlab.com/jeseibel/minecraft-lod-mod/-/issues/233
  
 <br>
 
 ## Compiling
 
 **From the File Explorer:**
-1. Download and extract the zip of the project
+1. Download and extract the project zip
 2. Download the core from https://gitlab.com/jeseibel/distant-horizons-core and extract into a folder called `core`
 3. Open a terminal emulator in the project folder (On Windows you can type `cmd` in the title bar)
 4. Run the commands: `./gradlew assemble`
 6. The compiled jar file will be in the folder `Merged`
 
-**If in terminal:**
+**From the command line:**
 1. `git clone --recurse-submodules https://gitlab.com/jeseibel/minecraft-lod-mod.git`
 2. `cd minecraft-lod-mod`
 3. `./gradlew assemble`
 4. The compiled jar file will be in the folder `Merged`
 
->Note: You can add the arg: `-PmcVer=1.?` to tell gradle to build a selected MC version instead of having to manually modify the `gradle.properties` file.
+>Note: You can add the arg: `-PmcVer=1.?` to tell gradle to build a selected MC version instead of having to modify the `gradle.properties` file.
 
 <Br>
 
@@ -117,7 +116,7 @@ If running in an IDE, to ensure the IDE noticed the version change, run a gradle
 
 `./gradlew --refresh-dependencies` to refresh local dependencies.
 
-`./gradlew clean` to reset everything (this does not affect your code) and then start the process again.
+`./gradlew clean` to delete any compiled code.
 
 
 ## Note to self
@@ -132,7 +131,7 @@ If your IDE fails to auto-detect the source jars when browsing Minecraft classes
 
 <br>
 
-## Useful commands
+## Other Useful commands
 
 Run the standalone jar: `./gradlew run`\
 Build the standalone jar: `./gradlew core:build`\
@@ -159,5 +158,5 @@ https://github.com/TheElectronWill/night-config
 SVG Salamander for SVG's\
 https://github.com/blackears/svgSalamander
 
-FlatLaf for theming (Tempory to test stuff)\
+FlatLaf for theming (for development testing)\
 https://www.formdev.com/flatlaf/