diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..c7ecf31 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,14 @@ +1.1.0 (September 28, 2020) +------------------------------ +* Fixed a `NoSuchMethodError` in the generated JAR file. +* *Internal: Switched from Ant to Maven* +* *Internal: Updated libraries* + +1.0.1 (September 15, 2020) +------------------------------ +* Lazy creation of monitor connection (see #1) +* Fixed misplaced shebang in start script + +1.0.0 (May 29, 2020) +------------------------------ +*Initial release* diff --git a/README.md b/README.md index 48788d7..2d7ad24 100644 --- a/README.md +++ b/README.md @@ -24,12 +24,22 @@ It should be compatible with older JREs, too, but this is not verified. ## Installation -- Clone the repository: `git clone https://github.com/magmaOffenburg/magmaFatProxy`. +### Prerequisites +- Make sure you have [simspark and rcssserver3d](https://gitlab.com/robocup-sim/SimSpark/-/wikis/home) installed and the command `rcssserver3d` is available on your command line. - Make sure you have Java installed and available on your command line. -- Make sure you have [simspark and rcsserver3d](https://gitlab.com/robocup-sim/SimSpark/-/wikis/home) installed and the command `rcssserver3d` is available on your command line. -- The Fat Proxy itself does not require an installation. -For contributions, please set up `clang-format` as described [here](https://github.com/hsoautonomy/formatting). +### Getting the prebuilt version +We provide a prebuilt version of the Fat Proxy. You can download the latest version from the [Releases page](https://github.com/magmaOffenburg/magmaFatProxy/releases) (`magmaFatProxy.zip`). The Zip file contains the JAR file as well as the start script. + +### Building from source +- Clone the repository: `git clone https://github.com/magmaOffenburg/magmaFatProxy`. +- Switch into the project's root directory. +- If you have Maven installed and available on your command line, run `mvn package`. Else, we also added a Maven wrapper to the project: run `./mvnw package` instead to use it. +- In the target directory, you should now find a Zip file similar to the prebuilt version. + +The Fat Proxy itself does not require any further installation. Running the start script or the JAR file is sufficient. (Note: the start script has to stay in the same directory as the JAR file). + +For contributions, please set up `clang-format` as described [here](https://github.com/hsoautonomy/formatting). ## Preparation Before you can use the Fat Proxy, you have to configure the soccer server to run in sync mode. diff --git a/pom.xml b/pom.xml index 319bc9d..2877092 100644 --- a/pom.xml +++ b/pom.xml @@ -5,7 +5,7 @@ magmaOffenburg magmaFatProxy jar - 1.1.0-SNAPSHOT + 1.1.0 magmaFatProxy https://github.com/magmaOffenburg/magmaFatProxy