mirror of https://github.com/FreeCol/freecol.git
Updates the documentation with the 2GB memory requirement.
This commit is contained in:
parent
90e4df323e
commit
0cf011a4f3
|
@ -288,7 +288,7 @@ In order to compile FreeCol you will need Java and
|
||||||
\href{http://ant.apache.org/}{the Ant build system}. When these are
|
\href{http://ant.apache.org/}{the Ant build system}. When these are
|
||||||
installed, go to the root directory of FreeCol and type \verb$ant$ to
|
installed, go to the root directory of FreeCol and type \verb$ant$ to
|
||||||
build a JAR file containing the game. The game is started using the
|
build a JAR file containing the game. The game is started using the
|
||||||
command \verb$java -Xmx1G -jar FreeCol.jar$.
|
command \verb$java -Xmx2G -jar FreeCol.jar$.
|
||||||
|
|
||||||
If something goes wrong, please open a bug report at the
|
If something goes wrong, please open a bug report at the
|
||||||
\href{http://sourceforge.net/projects/freecol}{SourceForge page of
|
\href{http://sourceforge.net/projects/freecol}{SourceForge page of
|
||||||
|
@ -316,7 +316,7 @@ paragraphs.
|
||||||
\hypertarget{Command line options}{\subsection{Command line options}}
|
\hypertarget{Command line options}{\subsection{Command line options}}
|
||||||
|
|
||||||
If you are in the directory in which FreeCol is installed, you can
|
If you are in the directory in which FreeCol is installed, you can
|
||||||
start the game with the command \verb$java -Xmx1G -jar FreeCol.jar$.
|
start the game with the command \verb$java -Xmx2G -jar FreeCol.jar$.
|
||||||
This will tell the Virtual Machine to load the game and to set the
|
This will tell the Virtual Machine to load the game and to set the
|
||||||
maximum heap size to 512 MB. Refer to the manual of your Java Virtual
|
maximum heap size to 512 MB. Refer to the manual of your Java Virtual
|
||||||
Machine for details.
|
Machine for details.
|
||||||
|
|
|
@ -197,7 +197,7 @@ directory of your FreeCol "working copy" in order to compile the game.
|
||||||
The file \verb+FreeCol.jar+ will then be generated, and you can start
|
The file \verb+FreeCol.jar+ will then be generated, and you can start
|
||||||
the game simply by running the following command:
|
the game simply by running the following command:
|
||||||
|
|
||||||
\verb+java -Xmx1G -jar FreeCol.jar+
|
\verb+java -Xmx2G -jar FreeCol.jar+
|
||||||
|
|
||||||
Once Ant builds the JAR file, you can rebuild FreeCol as needed any time
|
Once Ant builds the JAR file, you can rebuild FreeCol as needed any time
|
||||||
a modification to the code requires testing. Using Ant to create
|
a modification to the code requires testing. Using Ant to create
|
||||||
|
|
|
@ -78,7 +78,7 @@ A: Use the command-line option --freecol-data to specify the location
|
||||||
|
|
||||||
Q: I am unable to start the game.
|
Q: I am unable to start the game.
|
||||||
A: Try running the game in windowed mode:
|
A: Try running the game in windowed mode:
|
||||||
'java -Xmx1G -jar FreeCol.jar --windowed'
|
'java -Xmx2G -jar FreeCol.jar --windowed'
|
||||||
|
|
||||||
|
|
||||||
V. Help, Feedback & Bug Reports
|
V. Help, Feedback & Bug Reports
|
||||||
|
|
|
@ -950,7 +950,7 @@ public final class FreeCol {
|
||||||
*/
|
*/
|
||||||
private static void printUsage(Options options, int status) {
|
private static void printUsage(Options options, int status) {
|
||||||
HelpFormatter formatter = new HelpFormatter();
|
HelpFormatter formatter = new HelpFormatter();
|
||||||
formatter.printHelp("java -Xmx1G -jar freecol.jar [OPTIONS]",
|
formatter.printHelp("java -Xmx2G -jar freecol.jar [OPTIONS]",
|
||||||
options);
|
options);
|
||||||
quit(status);
|
quit(status);
|
||||||
}
|
}
|
||||||
|
|
Loading…
Reference in New Issue