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.

Sign up for GitHub

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

Update readme #688

Merged
merged 2 commits into from
Sep 16, 2024
Merged

Update readme #688

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
29eb58c
Update readme
shameekganguly Sep 14, 2024
7b415fd
Merge branch 'gz-physics8' into readme
ahcorde Sep 16, 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
28 changes: 18 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,27 +79,33 @@ Please refer to the [examples directory](https://github.com/gazebosim/gz-physics

API and tutorials can be found at [https://gazebosim.org/libs/physics](https://gazebosim.org/libs/physics).

You can also generate the documentation from a clone of this repository by following these steps.
On Ubuntu, 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
1. You will need Doxygen, which can be installed using

```
sudo apt-get install doxygen
```

2. Clone the repository
2. Install dependencies
```
sudo apt-add-repository -s "deb http://packages.osrfoundation.org/gazebo/ubuntu-stable $(lsb_release -c -s) main"
sudo apt-get build-dep -y libgz-physics8-dev
```

3. Clone the repository

```
git clone https://github.com/gazebosim/gz-physics -b gz-physics8
```

3. Configure and build the documentation.
4. Configure and build the documentation.

```
cd gz-physics; mkdir build; cd build; cmake ../; make doc
cd gz-physics; mkdir build; cd build; cmake ..; make doc
```

4. View the documentation by running the following command from the build directory.
5. View the documentation by running the following command from the build directory.

```
firefox doxygen/html/index.html
Expand All @@ -109,7 +115,7 @@ You can also generate the documentation from a clone of this repository by follo

Follow these steps to run tests and static code analysis in your clone of this repository.

1. Follow the [source install instruction](#source-install).
1. Follow the "Source Installation" instructions in the [installation tutorial](https://gazebosim.org/api/physics/8/installation.html).

2. Run tests.

Expand All @@ -132,19 +138,21 @@ gz-physics
├── bullet Files for bullet plugin component.
├── bullet-featherstone Files for bullet-featherstone plugin component.
├── dartsim Files for dartsim plugin component.
├── example Examples about how to use the library
├── examples Examples about how to use the library.
├── heightmap Heightmap related header files.
├── include/gz/physics Header files.
├── mesh Files for mesh component.
├── resources Model and mesh resource files used by tests.
├── sdf Files for sdf component.
├── src Source files and unit tests.
├── test
│ ├── benchmark Benchmark tests.
│ ├── common_test Tests common to multiple physics plugins.
│ ├── include Header files for tests.
│ ├── integration Integration tests.
│ ├── performance Performance tests.
│ ├── plugins Plugins used in tests.
│ ├── regression Regression tests.
│ ├── resources Models and mesh resource files.
│ └── static_assert Tests involving compilation failures.
├── tpe
│ ├── lib Implementation of TPE engine.
Expand All @@ -164,7 +172,7 @@ Please see

# Versioning

This library uses [Semantic Versioning](https://semver.org/). Additionally, this library is part of the [Gazebo project](https://gazebosim.org) which periodically releases a versioned set of compatible and complimentary libraries. See the [Gazebo website](https://gazebosim.org) for version and release information.
This library uses [Semantic Versioning](https://semver.org/). Additionally, this library is part of the [Gazebo project](https://gazebosim.org) which periodically releases a versioned set of compatible and complementary libraries. See the [Gazebo website](https://gazebosim.org) for version and release information.

# License

Expand Down