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

Jump to bottom

Cleanup cargo manifest #16

Closed
wants to merge 3 commits into from
Closed

Cleanup cargo manifest #16

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bb9c3ea
remove license-file
Nov 6, 2023
d6312a6
update readme and cargo manifest
Nov 6, 2023
a0a545c
undo formatting changes
Nov 7, 2023
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
3 changes: 2 additions & 1 deletion Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ version = "0.1.0"
edition = "2021"
default-run = "redf"
license = "Apache-2.0"
license-file = "LICENSE"
repository = "https://github.com/osrf/redf"
description = "Generates ROS packages which define ROS endpoints"

[[bin]]
name = "generate-schema"
Expand Down
201 changes: 0 additions & 201 deletions LICENSE
View file
Open in desktop

This file was deleted.

4 changes: 3 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
### redf

`redf` stands for "ROS Endpoint Definition Format", it defines a yaml format which describes the endpoints of a ROS system.
`redf` helps to manage topics, services and actions used by ROS nodes.

The ROS message definition format only defines the structure of a message, service or action, it does not define "endpoints", things like the topic names and qos expected by the publisher and subscriber. `redf` attempts to fill that gap by defining "endpoints" from a yaml file and using that to generate ROS packages. `redf` aims to be the equivalent of openapi/swagger for ROS.

### Supported Distros

Expand Down
Loading