Skip to content

Commit

Permalink
SAMM CLI: Make native binaries easier to download via documentation
Browse files Browse the repository at this point in the history
Changes:
- Update documentation. Were added links to the native binaries for Linux and Windows.

Fixes: #494
  • Loading branch information
Yauhenikapl committed Jan 11, 2024
1 parent abdf701 commit aa55d3f
Showing 1 changed file with 11 additions and 11 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -32,17 +32,17 @@ alias samm='java -jar /location/to/samm-cli-{esmf-sdk-version}.jar'
----
====

For the Windows native binary:
. Download: download above or visit our github https://github.com/eclipse-esmf/esmf-sdk/releases[releases page] and download executable file for Windows.
. Extract: extract it to a location of your choice.
. Open Command Prompt: Launch the Command Prompt and navigate to the directory (samm-cli-windows) containing our application.
. Run: In the command prompt, execute the command ``./samm.exe` to start the application.

For the Linux native binary:
. Download: download above or visit our github https://github.com/eclipse-esmf/esmf-sdk/releases[releases page] and download executable file for Linux.
. Extract: Unpack the archive to your preferred directory.
. Open Terminal: Open the Terminal and navigate to the directory with the application.
. Execute: Run the application using the command `./samm`.
*For the Windows native binary:*
. *Download*: download above or visit our github https://github.com/eclipse-esmf/esmf-sdk/releases[releases page] and download executable file for Windows.
. *Extract*: extract it to a location of your choice.
. *Open Command Prompt*: Launch the Command Prompt and navigate to the directory (samm-cli-windows) containing our application.
. *Run*: In the command prompt, execute the command ``./samm.exe` to start the application.

*For the Linux native binary:*
. *Download*: download above or visit our github https://github.com/eclipse-esmf/esmf-sdk/releases[releases page] and download executable file for Linux.
. *Extract*: Unpack the archive to your preferred directory.
. *Open Terminal*: Open the Terminal and navigate to the directory with the application.
. *Execute*: Run the application using the command `./samm`.

Successful execution of a command is signaled by returning 0. In case of logical or some other internal problem error code 1 is returned.
Missing or wrong command parameters result in error code 2 being returned.
Expand Down

0 comments on commit aa55d3f

Please sign in to comment.