aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTyler Ferrari <tpoke.ferrari@gmail.com>2023-06-08 05:57:24 +0000
committerTyler Ferrari <tpoke.ferrari@gmail.com>2023-06-08 05:57:24 +0000
commite498bd79689dfc3f9a8fd4670b825dddcbc24842 (patch)
tree0c262f6f7e9d4a4c9afd51b783182f70e02d019d
parentd3de916c6982e08c8e5680ff6c43bcd6b736e832 (diff)
downloadNPEhero-e498bd79689dfc3f9a8fd4670b825dddcbc24842.tar.gz
NPEhero-e498bd79689dfc3f9a8fd4670b825dddcbc24842.tar.bz2
NPEhero-e498bd79689dfc3f9a8fd4670b825dddcbc24842.zip
Update README.md
-rw-r--r--README.md9
1 files changed, 4 insertions, 5 deletions
diff --git a/README.md b/README.md
index db3bdd1..6b68c29 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,5 @@
# Installation
-1. Install Java 17 or newer
+1. Install Java 17 or newer (except for the JDK11 build (not reccomended) )
1. Go to Deployments > Releases.
1. Download the correct ZIP for your OS
1. Unzip it into an empty directory
@@ -20,7 +20,7 @@
1. Paste the link into the VSCode popup
3. Click the run and debug button on the sidebar
1. Click "create launch.json" and open the file
-1. Add the key "vmArgs" and put in the VM arguements for your OS
+1. Add the key "vmArgs" and put in the [VM arguements](https://gitlab.sowgro.net/npeinc/npehero#java-vm-arguements) for your OS
For example:
```json
@@ -49,11 +49,10 @@ Do not forget the comma after the second to last item.
1. Check "Import all existing Eclipse projects after clone finishes"
1. Click finish
1. Right click on project > Propereties
-1. Select Run/Debug Settings
-1. Select Driver
+1. Select Run/Debug Settings > Driver
1. Click Edit
1. Click the Arguements tab
-1. Paste in the VM Arguements for your OS
+1. Paste in the [VM Arguements](https://gitlab.sowgro.net/npeinc/npehero#java-vm-arguements) for your OS
## Java VM Arguements
These are automatically run by the start files when installing from a ZIP.