Skip to content

Update README.md #34

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

Merged
pete-tempo merged 2 commits into from
Aug 18, 2025
Merged

Update README.md #34

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
07ebb47
Update README.md
pete-tempo Aug 18, 2025
7859c1a
Update README.md
pete-tempo Aug 18, 2025
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
7 changes: 5 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,18 @@ Follow the instructions from the [Getting Started](https://github.com/tempo-sim/
> Don't forget to recurse submodules (so you get the Tempo plugins) when cloning:
`git clone <your_repo> --recurse-submodules`
>
> If you do forget, run a `git submodule update --init Plugins/Tempo` to fix it
> If you do forget, run a `git submodule update --init --recursive Plugins/Tempo` to fix it

Refer to the [Compatibility](https://github.com/tempo-sim/Tempo/tree/release#compatibility), [Prerequisites](https://github.com/tempo-sim/Tempo/tree/release?tab=readme-ov-file#prerequisites), and [Environment Variables](https://github.com/tempo-sim/Tempo/tree/release?tab=readme-ov-file#environment-variables) sections from Tempo.

## Content
This project includes some free ([Creative Commons License](https://creativecommons.org/licenses/by/4.0/)) content for demonstration, the default environment and street sweeper. Most Tempo projects start by replacing that with domain-specific content.

## Code
This project contains very little code. For an example of how you can write your own RPCs and expose them to Python using Tempo, check out the [Greeter](https://github.com/tempo-sim/Greeter/) example plugin. This plugin is included in the TempoSample project, but you can turn it off (by editing the uproject file) or remove it once you get the idea. You can follow the same patterns to add services and RPCs to your own project code.
This project contains very little code. For an example of how you can write your own RPCs and expose them to Python using Tempo, check out the [Greeter](https://github.com/tempo-sim/Greeter/) example plugin. This plugin is included in the TempoSample project, but you can disable them (by editing the uproject file) or remove it once you get the idea. You can follow the same patterns to add services and RPCs to your own project code.

## TempoROS
[TempoROS](https://github.com/tempo-sim/TempoROS) is a standalone plugin, developed by the same authors, included in `Tempo` as a submodule. The `TempoROS` and `TempoROSBridge` plugins (the latter of which translates and forwards Tempo messages to and from ROS) are disabled by default in the `TempoSample` project. If you use ROS, enable them by by editing the uproject file.

## Python API
To try out the Tempo Python API (after running `Plugins/Tempo/Setup.sh` and `Scripts/Build.sh`):
Expand Down
Loading