Skip to content

Commit e789160

Browse files
committed
Update README.md
1 parent 373004a commit e789160

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

README.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,10 @@ The binaries are released in the hopes that it might help you take a fresh look
1313

1414
### How to start
1515

16-
Check out the
16+
Check out the releases section, download the isntaller for your system.
17+
You can also download the zip file, which does not require any installation.
18+
19+
The only 2 parameters that you mgiht want to change after installing/unzipping is the amount of memory allowed to be used by BatMass and the path to JRE (Java Runtime Environment) to be used. The minimum supported version is Java 7, which is also the recommended one.<br/>
20+
These parameters are stored in `<install_path>/etc/batmass.conf`<br/>
21+
- To change the memory limit, change `default_options` parameter, look for `-J-Xmx` in its value string. The default is `-J-Xmx4G`, which means 4Gb max will be allowed and if your machine does not have enough free memory, the JVM (Java Virtual Machine) might fail to start.<br/>
22+
- If you can't start the application and you are sure you have enough memory and a valid JRE installation, then try uncommenting `jdkhome` in batmass.conf. Even though named 'jdk..' it's actually the path to your JRE.

0 commit comments

Comments
 (0)