diff --git a/README.md b/README.md index 80bd8dee2..970f2cb38 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,33 @@ -# GURPS Character Sheet +## GURPS Character Sheet -GURPS Character Sheet (GCS) is a stand-alone, interactive, character sheet editor that allows you to build characters for the [GURPS](http://www.sjgames.com/gurps) 4th Edition roleplaying game system. +GURPS Character Sheet (GCS) is a stand-alone, interactive, character sheet +editor that allows you to build characters for the +[GURPS](http://www.sjgames.com/gurps) 4th Edition roleplaying game +system. -## Building from the command line +### Development -1. Make sure you have JDK 10 installed. You can download it for your platform here: http://www.oracle.com/technetwork/java/javase/downloads/index.html +I generally use the latest `Eclipse IDE for Eclipse Commiters` package from +http://www.eclipse.org/downloads/eclipse-packages/ for developing GCS. If you +are using Windows, make sure you set the +`General > Workspace > Default Text Encoding` preference to UTF8, as many +source files contain UTF8 characters and the Windows default encoding will +choke on them. -2. Make sure you have Apache ANT installed. You can download it for your platform here: https://ant.apache.org/bindownload.cgi +### Building from the command line + +1. Make sure you have JDK 10 installed. You can download it for your platform + here: http://www.oracle.com/technetwork/java/javase/downloads/index.html + +2. Make sure you have Apache ANT installed. You can download it for your + platform here: https://ant.apache.org/bindownload.cgi 3. Clone the source repositories: ``` - % git clone https://github.com/richardwilkes/com.lowagie.text % git clone https://github.com/richardwilkes/gcs - % git clone https://github.com/richardwilkes/gcs_library - % git clone https://github.com/richardwilkes/gnu.trove - % git clone https://github.com/richardwilkes/org.apache.commons.logging - % git clone https://github.com/richardwilkes/org.apache.fontbox - % git clone https://github.com/richardwilkes/org.apache.pdfbox - % git clone https://github.com/richardwilkes/toolkit + % cd gcs + % ant clone-deps ``` 4. Build and bundle the code for your platform: diff --git a/build.xml b/build.xml index abc65d5ab..550612221 100644 --- a/build.xml +++ b/build.xml @@ -205,7 +205,38 @@ - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +