Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
DanySK authored Dec 18, 2024
1 parent 1a98a4c commit 01205a7
Showing 1 changed file with 1 addition and 35 deletions.
36 changes: 1 addition & 35 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,33 +61,7 @@ gradlew.bat runAll
Note that the first launch will be rather slow, since Gradle will download all the required files.
They will get cached in the user's home folder (as per Gradle normal behavior).

### Using the redistributable jar file

If you got the redistributable, runnable Alchemist jar file (download it [here][Alchemist releases], you can use the alchemist command line to execute the provided simulations.

To learn which commands the alchemist CLI offers, use:

```bash
java -jar alchemist-redist-VERSION.jar --help
```
(remember to substitute VERSION with the alchemist version you actually have downloaded)

Suppose that you have copied such jar in the project root folder, and you want to launch the file `foo.yml` located in `src/main/yaml` using the effects file `effects/bar.aes`. You can do so by running:
```bash
java -jar alchemist-redist-VERSION.jar -y src/main/yaml/foo.yml -g effects/bar.aes
```
If your YAML simulation file refers to an external protelis resource, that should be located in the classpath to get correctly loaded.
In this case, you may want to manually control the classpath to make sure everything is correctly considered.
Let's suppose that you store your Protelis modules structure in a `src/main/protelis` folder located in the root project folder. In this case you may want to issue:
```bash
java -cp alchemist-redist-VERSION.jar:src/main/protelis it.unibo.alchemist.Alchemist -y src/main/yaml/foo.yml -g effects/bar.aes
```
If you are running Alchemist on Windows and using the DOS command interpreter, be wary that that the colon must get substituted by a semicolon:
```bash
java -cp alchemist-redist-VERSION.jar;src/main/protelis it.unibo.alchemist.Alchemist -y src/main/yaml/foo.yml -g effects/bar.aes
```

## Graphical interface shortcuts
## Graphic interface shortcuts

The graphical interface that pops up when Alchemist is executed providing a YAML file on the command line is a stripped-down version of the one that shows when the simulator is invoked by `java -jar` or by double clicking.

Expand All @@ -109,13 +83,5 @@ In order to use such interface, consider the following command list:
| O | in select mode | Selected nodes can be moved by drag and drop |
| E | in select mode | Enters edit mode (to manually change node contents) |


## Eclipse users

This project includes the eclipse configuration files and can be imported directly in the IDE.
The usage of Gradle Buildship is recommended (it is shipped with Eclipse Mars and newer, and it is available in the Eclipse Marketplace anyway).
Use File -> Import -> Git -> Import project from Git and paste the address of this repository to start cloning.


[Alchemist releases]: https://github.com/AlchemistSimulator/Alchemist/releases
[Gradle]: http://gradle.org/

0 comments on commit 01205a7

Please sign in to comment.