Skip to content

Commit

Permalink
Updates README file. (#3)
Browse files Browse the repository at this point in the history
  • Loading branch information
francocipollone committed Dec 3, 2020
1 parent 485e633 commit e94be73
Showing 1 changed file with 44 additions and 0 deletions.
44 changes: 44 additions & 0 deletions README.md
@@ -1 +1,45 @@
# maliput_malidrive

A maliput backend.

## Build

1. Setup a maliput_malidrive (or a wider maliput) development workspace as described [here](https://github.com/ToyotaResearchInstitute/dsim-repos-index/tree/master/README.md)

2. Bring up your development workspace:

```sh
cd path/to/my/workspace
source ./bringup
```

3. Build maliput_malidrive packages and their dependencies:

```sh
colcon build --packages-up-to maliput_malidrive
```

## Run sample applications

1. Bring up your development workspace:

```sh
cd path/to/my/workspace
source ./bringup
```

2. Source your build:

```sh
source ./install/setup.bash
```

And then run one of the sample applications. To fully inspect them, visit the
`applications` directory.

There are more applications for using `maliput_malidrive` backend.
See [maliput_integration](https://github.com/ToyotaResearchInstitute/maliput-integration) repository.

## Documentation

See [maliput_documentation](https://github.com/ToyotaResearchInstitute/maliput-documentation) repository for further documentation.

0 comments on commit e94be73

Please sign in to comment.