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

Merge sdf15 ➡️ main #1516

Merged
merged 19 commits into from
Dec 13, 2024
Merged
Changes from 1 commit
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
68159a7
Fix symbol checking test when compiled with debug symbols (#1474)
j-rivero Aug 27, 2024
22684cb
Improve installation instructions (#1490)
scpeters Oct 29, 2024
bf36eb7
Change sdf_config.h to sdf/config.hh everywhere (#1494)
mjcarroll Nov 4, 2024
3dcdd55
Permit building python bindings separately from libsdformat library (…
scpeters Nov 5, 2024
dcd3cd6
Improve installation instructions (#1496)
mergify[bot] Nov 6, 2024
9661794
Only look for psutil if testing is enabled (#1495)
azeey Nov 6, 2024
91d9029
Permit building python bindings separately from libsdformat library (…
mergify[bot] Nov 7, 2024
d0bcd40
Support removing the actor, light, or model from the root (#1492)
nkoenig Nov 12, 2024
87932fe
Add bzlmod support to sdf15 (#1493)
mjcarroll Nov 12, 2024
bddaf0d
Bazel CI (#1500)
shameekganguly Nov 12, 2024
bf6b2fa
Merge branch 'sdf14' into scpeters/merge_14_15
scpeters Nov 13, 2024
b105b30
Merge pull request #1501 from gazebosim/scpeters/merge_14_15
scpeters Nov 13, 2024
e40c32f
Prepare for 15.1.0 release (#1502)
scpeters Nov 13, 2024
66e4ead
Fix bazel rules for layering_check and parse_headers with clang (#1507)
mjcarroll Nov 15, 2024
0a36844
Enable header layering checks for bazel build (#1505)
shameekganguly Nov 16, 2024
cc524e7
Prepare for release 15.1.1 (#1508)
mjcarroll Nov 16, 2024
4ebe022
Permit to test when building bindings separately from main library (#…
traversaro Nov 18, 2024
69c82c0
python bindings: get version from package.xml (#1504)
scpeters Dec 3, 2024
9423fe2
Merge branch 'sdf15' into scpeters/merge_15_main
scpeters Dec 13, 2024
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
Prev Previous commit
Next Next commit
Improve installation instructions (#1496)
Backport of #1490.

* Refer to https://brew.sh instead of duplicating the
  brew installation command.
* List cmake variables in a markdown table.
* Combine Ubuntu and macOS installation instructions

(cherry picked from commit 22684cb)

Signed-off-by: Steve Peters <[email protected]>
Co-authored-by: Steve Peters <[email protected]>
mergify[bot] and scpeters authored Nov 6, 2024

Verified

This commit was signed with the committer’s verified signature.
Steveb-p Paweł Niedzielski
commit dcd3cd61402a2278db3ac021442a6e7458fa79b9
71 changes: 25 additions & 46 deletions README.md
Original file line number Diff line number Diff line change
@@ -71,9 +71,9 @@ which version you need, or leave it empty for version 1.

### macOS

On macOS, add OSRF packages:
On macOS, after installing the [Homebrew package manager](https://brew.sh),
add OSRF packages:
```sh
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
brew tap osrf/simulation
```

@@ -129,6 +129,25 @@ git clone https://github.com/gazebosim/sdformat -b sdf<#>
Be sure to replace `<#>` with a number value, such as 1 or 2, depending on
which version you need.

### Install dependencies

#### Ubuntu

```sh
cd sdformat
sudo apt -y install \
$(sort -u $(find . -iname 'packages-'`lsb_release -cs`'.apt' -o -iname 'packages.apt' | tr '\n' ' '))
```

#### macOS

```sh
brew install --only-dependencies sdformat<#>
```

Be sure to replace `<#>` with a number value, such as 14 or 15, depending on
which version you need.

### Build from Source

Standard installation can be performed in UNIX systems using the following
@@ -144,12 +163,10 @@ make install

sdformat supported cmake parameters at configuring time:

* `USE_INTERNAL_URDF` (`bool`) [default `False`] <br/>
Use an internal copy of urdfdom 1.0.0 instead of look for one
installed in the system
* `USE_UPSTREAM_CFLAGS` (`bool`) [default `True`] <br/>
Use the sdformat team compilation flags instead of the common set defined
by cmake.
| Name | Type | Default | Description |
|-----------------------|------|----------|--------------------------------------|
| `USE_INTERNAL_URDF` | BOOL | False | Use an internal copy of urdfdom 1.0.0 instead of looking for one installed in the system |
| `USE_UPSTREAM_CFLAGS` | BOOL | True | Use the sdformat team compilation flags instead of the common set defined by cmake. |

## Uninstallation

@@ -160,44 +177,6 @@ cd build
make uninstall
```

## macOS

### Prerequisites

Clone the repository
```sh
git clone https://github.com/gazebosim/sdformat -b sdf<#>
```
Be sure to replace `<#>` with a number value, such as 1 or 2, depending on
which version you need.

Install dependencies
```sh
brew install --only-dependencies sdformat<#>
```

### Build from Source

1. Configure and build
```sh
cd sdformat
mkdir build
cd build
cmake .. # Consider specifying -DCMAKE_INSTALL_PREFIX=...
make
```

2. Optionally, install and uninstall
```sh
sudo make install
```

To uninstall the software installed with the previous steps:
```sh
cd build/
sudo make uninstall
```

## Windows

### Prerequisites