From d8460438571546f84c69e2c777bc550deb56e98e Mon Sep 17 00:00:00 2001 From: Emmanuel Godard <emmanuel.godard@lis-lab.fr> Date: Fri, 3 May 2019 11:38:05 +0200 Subject: [PATCH] correct README for breaking changes in 0.8 --- README.md | 19 +++++++++---------- 1 file changed, 9 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 87af95e..3b244b1 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,6 @@ ``` ./gradlew downloadAndUnzipFile -./gradlew installJBotsim ``` ## Getting started without IDE @@ -12,11 +11,11 @@ 1. Write your java algorithm into the `src` folder : `MyAlgo.java` 2. Configure your `PATH` variable ``` -export PATH=$PATH:`pwd`/davis/bin +export PATH=$PATH:`pwd`/build/install/davis-beta/bin ``` 3. Execute in the `src` directory ``` -udavis <networkGeneratorFile> <scheme> <size> <algoFile : MyAlgo.java> +udavis -n <networkGeneratorFile> -i <ids> -s <size> -al <algoFile : MyAlgo.java> ``` @@ -25,15 +24,15 @@ udavis <networkGeneratorFile> <scheme> <size> <algoFile : MyAlgo.java> 1. Modify `commandLine` parameters for task `davis` in `build.gradle`. 3. Run ``` -./gradlew helloejcim +./gradlew hello ``` You can also collect all your examples in a `scenario` file 1. Open `scr/scenario` file and add a line with 5 parameters : -`<scenarioName> <networkGeneratorFile> <scheme> <size> <algoFile : MyAlgo.java>` -3. Execute in a terminal with `./gradlew runscenarioName` +`[<scenarioName>] -n <networkGeneratorFile> -i <scheme> -s <size> -al <algoFile : MyAlgo.java>` +3. Execute in a terminal with `./gradlew run[scenarioName]` ## Getting started with Intellij @@ -50,17 +49,17 @@ Choose the `basic-example` folder and click ok for *auto-import*. 1. Write your java algorithm into the `src` folder : `MyAlgo.java` 2. Open `src/scenario` file and add a line with 5 parameters : -`<testName> <networkGeneratorFile> <scheme> <size> <algoFile : MyAlgo.java>` +`[<scenarioName>] -n <networkGeneratorFile> -i <scheme> -s <size> -al <algoFile : MyAlgo.java>` 3. Refresh gradle panel. -4. In `Tasks/application` of the gradle panel you should see your testName as a -gradle task named "runtestName" +4. In `Tasks/application` of the gradle panel you should see your scenario as a +gradle task named `run[<scenarioName>]`. 5. Click to execute. ## Docs -See also [documentation for davis](https://gitlab.lis-lab.fr/davis/davis/tree/master/doc). +See also the [documentation for davis](https://gitlab.lis-lab.fr/davis/davis/tree/master/doc). -- GitLab