Skip to content

Commit

Permalink
Updated for packaged runtime binary release
Browse files Browse the repository at this point in the history
  • Loading branch information
WouterJansen committed Oct 3, 2024
1 parent ff63b1b commit 0b55326
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 1 deletion.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,8 @@ You can also find the presentation of the live tutorial of Cosys-AirSim at ANNSI
Some more details on our changes can be found in the [changelog](https://github.com/Cosys-Lab/Cosys-AirSim/blob/main/CHANGELOG.md).

## How to Get It

#### Download and run from packaged binary - Windows/Linux
* [Download and run it](https://cosys-lab.github.io/run_packaged)
#### Download and install from precompiled plugin - Windows/Linux
* [Download and install it](https://cosys-lab.github.io/install_precompiled)
#### Install and use from source - Windows
Expand Down
3 changes: 3 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,9 @@ Some more details on our changes can be found in the [changelog](https://github.

## How to Get It

## How to Get It
#### Download and run from packaged binary - Windows/Linux
* [Download and run it](https://cosys-lab.github.io/run_packaged)
#### Download and install from precompiled plugin - Windows/Linux
* [Download and install it](https://cosys-lab.github.io/install_precompiled)
#### Install and use from source - Windows
Expand Down
7 changes: 7 additions & 0 deletions docs/run_packaged.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Download and run Packaged Binary

If you wish to test the Cosys-AirSim plugin a simple environment without having to install Unreal Engine, you can download the prepackaged binary for the Blocks test environment from the [releases page](https://github.com/Cosys-Lab/Cosys-AirSim/releases) and run it as a binary executable on Windows (_Blocks.exe_) or start it with a shell script (_./Blocks.sh_) on Linux systems.
They support multiple launch arguments. More info can be found [here](https://dev.epicgames.com/documentation/en-us/unreal-engine/command-line-arguments-in-unreal-engine?application_version=5.4).

The releases page also comes with additional downloads and links to the several API implementations for ROS(2) and the Python and Matlab API clients for that specific version of the Cosys-AirSim plugin.

1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ nav:
- "Home": 'README.md'
- "Changelog": 'https://github.com/Cosys-Lab/Cosys-AirSim/blob/main/CHANGELOG.md'
- "Installing AirSim":
- "Download and run": 'run_packaged.md'
- "Download and install from precompiled plugin": 'install_precompiled.md'
- "Install from Source on Windows": 'install_windows.md'
- "Install from Source on Linux": 'install_linux.md'
Expand Down

0 comments on commit 0b55326

Please sign in to comment.