From ea2bde729fc7f01bb3f83d2483729ffa4aaffc5a Mon Sep 17 00:00:00 2001 From: Hugo Roussel <hugo.roussel@univ-tlse3.fr> Date: Fri, 26 Jul 2019 11:46:57 +0200 Subject: [PATCH] Updated README --- AMOEBAonAMAK/README.md | 17 ----------------- README.md | 21 +++++++++++++++++---- 2 files changed, 17 insertions(+), 21 deletions(-) delete mode 100644 AMOEBAonAMAK/README.md diff --git a/AMOEBAonAMAK/README.md b/AMOEBAonAMAK/README.md deleted file mode 100644 index daac3b82..00000000 --- a/AMOEBAonAMAK/README.md +++ /dev/null @@ -1,17 +0,0 @@ -# AMOEBA on AMAK -An AMOEBA3 port on AMAK. - -## Quick start -```Java -// Create a world and a studied system for your amoeba -World world = new World(); -StudiedSystem studiedSystem = new F_XY_System(50.0); -AMOEBA amoeba = new AMOEBA(world, studiedSystem); -// Create a backup system for the amoeba -IBackupSystem backupSystem = new BackupSystem(amoeba); -// Load a configuration matching the studied system -File file = new File("resources\\twoDimensionsLauncher.xml"); -backupSystem.loadXML(file); -// The amoeba is ready to be used -``` -You can find a more complete exemple at `experiment.Main.java`. \ No newline at end of file diff --git a/README.md b/README.md index fca184d2..f53d24a2 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,15 @@ # AMAKFX and AMOEBAonAMAK -Tested with openjdk 11. +Tested with OpenJDK 11, should work with Java 8. -## Build Jar with dependencies +Check [the documentation directory](documentation) for more detailed and in depth instruction and explanation. + +Check AMAKFX's [README](AMAKFX/README.md) for more detail on how to use it. + +# Quick start : +## Maven build Jar with dependencies `mvn clean compile assembly:single` -Note that the resulting jars are not platform independant. +Note that the resulting jars are not platform independent. ## Use with Eclipse Clone this repo and import it as a Maven project. @@ -16,5 +21,13 @@ AMOEBA-parent | AMAKFX | AMOEBAonAMAK ``` -For more detail on [AMOEBAonAMAK](AMOEBAonAMAK/README.md) or [AMAKFX](AMAKFX/README.md), check their respective README. +Check AMAKFX's [README](AMAKFX/README.md) for more detail on how to use it. + +Check [the documentation directory](documentation) for more detailed and in depth instruction and explanation on AMOEBA. + +### Amoeba Quick start +```Java +StudiedSystem studiedSystem = new F_XY_System(50.0); +AMOEBA amoeba = new AMOEBA("resources/twoDimensionsLauncher.xml", studiedSystem); +``` \ No newline at end of file -- GitLab