diff --git a/Changelog.md b/Changelog.md index e08532f2..9f73d6b8 100644 --- a/Changelog.md +++ b/Changelog.md @@ -1,8 +1,20 @@ ## Gazebo Fuel Tools 10.x -### Gazebo Fuel Tools 10.0.0 (2024-09-XX) +### Gazebo Fuel Tools 10.0.0 (2024-09-25) -Changes since 9.1.0 +1. **Baseline:** this includes all changes from 9.1.0 and earlier. + +1. Miscellaneous documentation fixes + * [Pull request #445](https://github.com/gazebosim/gz-fuel-tools/pull/445) + * [Pull request #444](https://github.com/gazebosim/gz-fuel-tools/pull/444) + * [Pull request #443](https://github.com/gazebosim/gz-fuel-tools/pull/443) + * [Pull request #442](https://github.com/gazebosim/gz-fuel-tools/pull/442) + +1. Update badges to point to gz-fuel-tools10 + * [Pull request #439](https://github.com/gazebosim/gz-fuel-tools/pull/439) + +1. Ionic changelog + * [Pull request #438](https://github.com/gazebosim/gz-fuel-tools/pull/438) 1. Require cmake 3.22.1 * [Pull request #436](https://github.com/gazebosim/gz-fuel-tools/pull/436) diff --git a/README.md b/README.md index d8c30fa7..72ddc262 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ interacting with Gazebo Fuel servers. # Building and installing -See the [installation tutorial](https://gazebosim.org/api/fuel_tools/9/install.html). +See the [installation tutorial](https://gazebosim.org/api/fuel_tools/10/install.html). Make sure `GZ_CONFIG_PATH` is set to the right install location so that `gz fuel` will work. Default is `/usr/local/share/gz`. @@ -31,7 +31,8 @@ Default is `/usr/local/share/gz`. For a complete list of commands run `gz fuel -h` on the command line. **List all models** -```{.sh} + +```bash $ gz fuel list -t model -r | head https://fuel.gazebosim.org/anonymous/test_model_595389531 https://fuel.gazebosim.org/anonymous/test_model_122023392 @@ -46,7 +47,8 @@ https://fuel.gazebosim.org/anonymous/test_model_380348669 ``` **Download a model** -```{.sh} + +```bash $ gz fuel download -u https://fuel.gazebosim.org/1.0/OpenRobotics/models/Ambulance -v 4 Downloading model: Name: Ambulance @@ -98,14 +100,15 @@ in. Create a private token at [https://app.gazebosim.org/settings#access_tokens](https://app.gazebosim.org/settings#access_tokens). Store the generated token someplace safe. -The private token can then used to upload a model: -```{.sh} +The private token can then be used to upload a model: +```bash gz fuel upload -m ~/path_to_model --header 'Private-token: ' ``` ## Dependencies On ubuntu run -```{.sh} + +```bash sudo apt install ruby-ffi libzip-dev libcurl-dev libjsoncpp-dev ``` diff --git a/src/cmd/CMakeLists.txt b/src/cmd/CMakeLists.txt index 833f2856..d6a1ea74 100644 --- a/src/cmd/CMakeLists.txt +++ b/src/cmd/CMakeLists.txt @@ -31,7 +31,15 @@ set(cmd_script_configured "${CMAKE_CURRENT_BINARY_DIR}/${CMD_NAME}${PROJECT_VERS # Set the library_location variable to the relative path to the library file # within the install directory structure. -set(library_location "../../../${CMAKE_INSTALL_LIBDIR}/$") +if (MSVC) + set(library_location_prefix "${CMAKE_INSTALL_BINDIR}") +else() + set(library_location_prefix "${CMAKE_INSTALL_LIBDIR}") +endif() + +# Set the library_location variable to the relative path to the library file +# within the install directory structure. +set(library_location "../../../${library_location_prefix}/$") configure_file( "${CMD_NAME}.rb.in" diff --git a/tutorials/03_command_line.md b/tutorials/03_command_line.md index cad58e74..7239a306 100644 --- a/tutorials/03_command_line.md +++ b/tutorials/03_command_line.md @@ -31,8 +31,7 @@ https://fuel.gazebosim.org By default, Fuel will list resources from all the servers listed in your `config.yaml` file. See the \ref configuration for more details. -> **Tip**: If you want to see resources from a different Fuel server, add it to -`config.yaml` to and re-run the list command to see resources from both servers! +> **Tip**: If you want to see resources from a different Fuel server, add it to `config.yaml` to and re-run the list command to see resources from both servers! There are a few other options on the command, run the help to see all of them: @@ -123,7 +122,10 @@ sub-command. You can access the list of edit options using: gz fuel edit -h ``` -You must be the resource owner, or an authorized member of the organization that owns the resource, in order to edit the resource. This in turn means you must use the `--header 'Private-token: YOUR_TOKEN'` option with the `edit` sub-command. +You must be the resource owner, or an authorized member of the organization that owns the resource, in order to edit the resource. This in turn means you must use the next option with the `edit` subcommand: +``` +--header 'Private-token: YOUR_TOKEN' +``` ### Change resource privacy diff --git a/tutorials/04_cpp_api.md b/tutorials/04_cpp_api.md index 1555c228..5a420ca1 100644 --- a/tutorials/04_cpp_api.md +++ b/tutorials/04_cpp_api.md @@ -13,6 +13,12 @@ this tutorial: mkdir /tmp/fuel_tutorial && cd /tmp/fuel_tutorial ``` +Install compilation prerequisites: + +```bash +sudo apt-get install libgflags-dev +``` + Download the files `list.cc`, `details.cc`, `download.cc`, `CMakeLists.txt`, and save them under `/tmp/fuel_tutorial`: @@ -172,7 +178,7 @@ for (const auto &server : client.Config().Servers()) id.SetServer(server); gz::fuel_tools::ModelIdentifier model; - if (!client.ModelDetails(server, id, model)) + if (!client.ModelDetails(id, model)) continue; std::cout << model.AsPrettyString() << std::endl;