Skip to content

Commit

Permalink
Update installation instructions in README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ll7 committed May 31, 2024
1 parent 08c1c07 commit 705ecb4
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
> 2024-03-28 Under Development. See <https://github.com/ll7/robot_sf_ll7/issues>.
## About

This project provides a training environment for the simulation of a robot moving
in a pedestrian-filled space.

Expand All @@ -18,6 +19,15 @@ map data from OpenStreetMap.

![](./docs/video/demo_01.gif)

## Installation

This project currently supports **two** methods for installation:
1. `.devcontainer` for Visual Studio Code [.devcontainer/readme.md](./.devcontainer/readme.md)
2. Manual installation

For 1. follow the instructions in the `.devcontainer` directory.
For 2. follow the instructions below:

## Quickstart

### 1. Clone Source Code
Expand Down

0 comments on commit 705ecb4

Please sign in to comment.