Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improved Windows instructions #242

Merged
merged 2 commits into from
Mar 30, 2021
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 25 additions & 3 deletions examples/hello_world_loader/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,29 @@ plugins, according to a desired feature list.

From the root of the `ign-physics` repository, do the following to build the example:

~~~
```bash
cd examples/hello_world_loader
mkdir build
cd build
cmake ..
```

### Ubuntu Or MacOS

```bash
make
~~~
```

This will generate the `hello_world_loader` executable under `build`.

### Windows

```bash
cmake --build . --config Release
```

This will generate the `hello_world_loader` executable under `build\Release`.

## Run

This loader will load any plugin that implements the `GetEngineInfo` feature,
Expand Down Expand Up @@ -46,17 +59,26 @@ Testing plugin: ignition::physics::dartsim::Plugin
engine name: dartsim-6.10.0
~~~

### Hello world plugin on Linux
### Hello world plugin

This loader should also be able to load the hello world plugin example.
After you've followed the instructions to compile both the plugin and the
loader, you can load the plugin like:

#### On Linux

~~~
cd examples/hello_world_loader/build
./hello_world_loader ../../hello_world_plugin/build/libHelloWorldPlugin.so
~~~

#### On Windows

~~~
cd examples/hello_world_loader/build
chapulina marked this conversation as resolved.
Show resolved Hide resolved
.\Release\hello_world_loader.exe ..\..\hello_world_plugin\build\Release\HelloWorldPlugin.dll
~~~

And see the following printed:

~~~
Expand Down
16 changes: 13 additions & 3 deletions examples/hello_world_plugin/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,24 @@ Ignition Physics.

From the root of the `ign-physics` repository, do the following to build the example:

~~~
```bash
cd examples/hello_world_plugin
mkdir build
cd build
cmake ..
```

### Ubuntu Or MacOS

```bash
make
~~~
```

### Windows

```bash
cmake --build . --config Release
```

This will generate the `HelloWorldPlugin` library under `build`.
The exact name of the library file depends on the operating system
Expand All @@ -25,4 +36,3 @@ and `HelloWorldPlugin.dll` on Windows.
The resulting plugin can be loaded by any plugin loader that requests the
features implemented by the plugin. See an example loader at
`examples/hello_world_loader`.