Skip to content

Commit

Permalink
update readme, add emojis
Browse files Browse the repository at this point in the history
  • Loading branch information
luigiberducci committed Dec 28, 2023
1 parent fc678cc commit b4dea39
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ system and unsafe set.

![Example CBF Single-Integrator](docs%2Fsingle_integrator.gif)

## Installation
## :wrench: Installation
The code is written in Python 3.10 and uses [PyTorch](https://pytorch.org/) for
learning a CBF.
We recommend using a virtual environment.
Expand All @@ -29,7 +29,7 @@ To install the required dependencies, run
pip install -r requirements.txt
```

## Examples
## :rocket: Examples
We provide a simple example for a single-integrator system in
[`run_example.py`](run_example.py).

Expand All @@ -38,7 +38,7 @@ To run the example, run
python run_example.py
```

## Disclaimer
## :warning: Disclaimer
This is a research prototype, tailored for CBF and built on top of [FOSSIL](https://github.com/oxford-oxcav/fossil).
Our implementation aims to refactor the original codebase and keep the minimal functionality required for CBF synthesis.

Expand Down

0 comments on commit b4dea39

Please sign in to comment.