Merge branch 'gz-utils2' of github.com:gazebosim/gz-utils into main

CMakeLists.txt

@@ -17,7 +17,7 @@ find_package(gz-cmake3 REQUIRED)
 set(CMAKE_CXX_STANDARD 17)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
 
-gz_configure_project(VERSION_SUFFIX pre1)
+gz_configure_project(VERSION_SUFFIX)
 
 #============================================================================
 # Set project-specific options

Changelog.md

@@ -6,6 +6,40 @@
 
 ## Gazebo Utils 2.0.0 (20XX-XX-XX)
 
+1. Improve install instructions
+    * [Pull request #80](https://github.com/gazebosim/gz-utils/pull/80)
+
+1. Round out ExtraTestMacros
+    * [Pull request #74](https://github.com/gazebosim/gz-utils/pull/74)
+
+1. Update GoogleTest to latest version
+    * [Pull request #63](https://github.com/gazebosim/gz-utils/pull/63)
+    * [Pull request #77](https://github.com/gazebosim/gz-utils/pull/77)
+
+1. cli_TEST: Fix compatibility with CLI11 2.0
+    * [Pull request #60](https://github.com/gazebosim/gz-utils/pull/60)
+
+1. Include `<functional>` in FormatterFwd
+    * [Pull request #58](https://github.com/gazebosim/gz-utils/pull/58)
+
+1. `ign` to `gz` Migration
+    * [Pull request #53](https://github.com/gazebosim/gz-utils/pull/53)
+    * [Pull request #55](https://github.com/gazebosim/gz-utils/pull/55)
+    * [Pull request #57](https://github.com/gazebosim/gz-utils/pull/57)
+    * [Pull request #59](https://github.com/gazebosim/gz-utils/pull/59)
+    * [Pull request #61](https://github.com/gazebosim/gz-utils/pull/61)
+    * [Pull request #62](https://github.com/gazebosim/gz-utils/pull/62)
+    * [Pull request #64](https://github.com/gazebosim/gz-utils/pull/64)
+    * [Pull request #65](https://github.com/gazebosim/gz-utils/pull/65)
+    * [Pull request #67](https://github.com/gazebosim/gz-utils/pull/67)
+    * [Pull request #69](https://github.com/gazebosim/gz-utils/pull/69)
+    * [Pull request #70](https://github.com/gazebosim/gz-utils/pull/70)
+
+1. Infrastructure
+    * [Pull request #43](https://github.com/gazebosim/gz-utils/pull/43)
+    * [Pull request #49](https://github.com/gazebosim/gz-utils/pull/49)
+    * [Pull request #72](https://github.com/gazebosim/gz-utils/pull/72)
+
 ## Gazebo Utils 1.x
 
 ## Gazebo Utils 1.4.0 (2022-03-29)

README.md

@@ -49,7 +49,7 @@ Gazebo Utils provides a wide range of functionality, including:
 
 # Install
 
-See the [installation tutorial](https://gazebosim.org/api/utils/0.1/install.html).
+See the [installation tutorial](https://gazebosim.org/api/utils/2.0/install.html).
 
 # Usage
 

src/CMakeLists.txt

@@ -1,4 +1,4 @@
 gz_get_libsources_and_unittests(sources gtest_sources)
 
-gz_create_core_library(SOURCES ${sources} CXX_STANDARD ${c++standard})
+gz_create_core_library(SOURCES ${sources} CXX_STANDARD ${CMAKE_CXX_STANDARD})
 gz_build_tests(TYPE UNIT SOURCES ${gtest_sources})

tutorials/installation.md

@@ -46,12 +46,47 @@ sudo apt install libgz-utils<#>-dev
 Be sure to replace `<#>` with a number value, such as 1 or 2, depending on
 which version you need.
 
+### macOS
+
+On macOS, add OSRF packages:
+  ```
+  /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
+  brew tap osrf/simulation
+  ```
+
+Install Gazebo utils:
+  ```
+  brew install gz-utils<#>
+  ```
+
+Be sure to replace `<#>` with a number value, such as 1 or 2, depending on
+which version you need.
+
+### Windows
+
+Install [Conda package management system](https://docs.conda.io/projects/conda/en/latest/user-guide/install/download.html).
+Miniconda suffices.
+
+Create if necessary, and activate a Conda environment:
+```
+conda create -n gz-ws
+conda activate gz-ws
+```
+
+Install `gz-utils`:
+```
+conda install libgz-utils<#> --channel conda-forge
+```
+
+Be sure to replace `<#>` with a number value, such as 1 or 2, depending on
+which version you need.
+
 ## Source Install
 
 Source installation can be performed in UNIX systems by first installing the
 necessary prerequisites followed by building from source.
 
-### Building from source
+### Ubuntu
 
 1. Install tools
   ```
@@ -84,3 +119,102 @@ necessary prerequisites followed by building from source.
     ```
     sudo make install
     ```
+
+### macOS
+
+1. Clone the repository
+  ```
+  git clone https://github.com/gazebosim/gz-utils -b gz-utils<#>
+  ```
+  Be sure to replace `<#>` with a number value, such as 1 or 2, depending on
+  which version you need.
+
+2. Install dependencies
+  ```
+  brew install --only-dependencies gz-utils<#>
+  ```
+  Be sure to replace `<#>` with a number value, such as 1 or 2, depending on
+  which version you need.
+
+3. Configure and build
+  ```
+  cd gz-utils
+  mkdir build
+  cd build
+  cmake ..
+  make
+  ```
+
+4. Optionally, install
+  ```
+  sudo make install
+  ```
+### Windows
+
+This assumes you have created and activated a Conda environment while installing the Prerequisites.
+
+1. Navigate to where you would like to build the library, and clone the repository.
+  ```
+  # Optionally, append `-b gz-utils#` (replace # with a number) to check out a specific version
+  git clone https://github.com/gazebosim/gz-utils.git
+  ```
+
+2. Configure and build
+  ```
+  cd gz-utils
+  mkdir build
+  cd build
+  cmake .. -DBUILD_TESTING=OFF  # Optionally, -DCMAKE_INSTALL_PREFIX=path\to\install
+  cmake --build . --config Release
+  ```
+
+3. Optionally, install
+  ```
+  cmake --install . --config Release
+  ```
+
+# Documentation
+
+API and tutorials can be found at [https://gazebosim.org/libs/utils](https://gazebosim.org/libs/utils).
+
+You can also generate the documentation from a clone of this repository by following these steps.
+
+1. You will need Doxygen. On Ubuntu Doxygen can be installed using
+  ```
+  sudo apt-get install doxygen
+  ```
+
+2. Clone the repository
+  ```
+  git clone https://github.com/gazebosim/gz-utils
+  ```
+
+3. Configure and build the documentation.
+  ```
+  cd gz-utils
+  mkdir build
+  cd build
+  cmake ../
+  make doc
+  ```
+
+4. View the documentation by running the following command from the build directory.
+  ```
+  firefox doxygen/html/index.html
+  ```
+
+# Testing
+
+Follow these steps to run tests and static code analysis in your clone of this repository.
+
+1. Follow the [source install instruction](#source-install).
+
+2. Run tests.
+  ```
+  make test
+  ```
+
+3. Static code checker.
+  ```
+  make codecheck
+  ```