diff --git a/examples/hello_world_loader/README.md b/examples/hello_world_loader/README.md index f10bd40fa..d9bbf71be 100644 --- a/examples/hello_world_loader/README.md +++ b/examples/hello_world_loader/README.md @@ -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, @@ -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 +.\Release\hello_world_loader.exe ..\..\hello_world_plugin\build\Release\HelloWorldPlugin.dll +~~~ + And see the following printed: ~~~ diff --git a/examples/hello_world_plugin/README.md b/examples/hello_world_plugin/README.md index 6e50d0c5d..4df41c6d4 100644 --- a/examples/hello_world_plugin/README.md +++ b/examples/hello_world_plugin/README.md @@ -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 @@ -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`. -