Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
chhh committed Jun 2, 2015
1 parent 373004a commit e789160
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,10 @@ The binaries are released in the hopes that it might help you take a fresh look

### How to start

Check out the
Check out the releases section, download the isntaller for your system.
You can also download the zip file, which does not require any installation.

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/>
These parameters are stored in `<install_path>/etc/batmass.conf`<br/>
- 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/>
- 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 comments on commit e789160

Please sign in to comment.