Skip to content

Commit c88779c

Browse files
Saurav AgarwalSaurav Agarwal
authored andcommitted
Fix docs
1 parent b55cfcb commit c88779c

File tree

3 files changed

+21
-2
lines changed

3 files changed

+21
-2
lines changed

README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ See full documentation at [https://KumarRobotics.github.io/CoverageControl/](htt
44

55
Coverage control is the problem of navigating a robot swarm to collaboratively monitor features or a phenomenon of interest not known _a priori_.
66
The library provides a simulation environment, algorithms, and GNN-based architectures for the coverage control problem.
7-
<img align="right" width="300" src="https://github.com/KumarRobotics/CoverageControl/blob/main/doc/graphics/LPAC.gif">
7+
<img align="right" width="300" src="https://kumarrobotics.github.io/CoverageControl/LPAC.gif">
88

99
**Key features:**
1010
- The core library `CoverageControlCore` is written in `C++` and `CUDA` to handle large-scale simulations
@@ -13,6 +13,15 @@ The library provides a simulation environment, algorithms, and GNN-based archite
1313
- Learnable Perception-Action-Communication (LPAC) architecture for the coverage control problem is implemented in `PyTorch` and `PyTorch Geometric`
1414
- GPU and CPU parallelization using `CUDA` and `OpenMP`
1515

16+
---
17+
## Quick Start
18+
The library is available as a `pip` package. To install the package, run the following command:
19+
```bash
20+
pip install coverage_control
21+
```
22+
23+
See the [Quick Start](https://kumarrobotics.github.io/CoverageControl/quick_start.html) guide for a quick introduction to the library.
24+
1625
---
1726

1827
## Citation

doc/manual/README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,16 @@ The library provides a simulation environment, algorithms, and GNN-based archite
1919

2020
---
2121

22+
## Quick Start
23+
The library is available as a `pip` package. To install the package, run the following command:
24+
```bash
25+
pip install coverage_control
26+
```
27+
28+
See the [Quick Start](quick_start.md) guide for a quick introduction to the library.
29+
30+
---
31+
2232
## Citation
2333
```
2434
@article{agarwal2024lpac,

doc/manual/lpac.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
\page lpac LPAC Neural Network
22
\tableofcontents
33

4-
# Prelminaries
4+
# Preliminaries
55
We will organize files in a **workspace** directory: `${CoverageControl_ws}` (e.g., ~/CoverageControl\_ws).
66

77
Download and extract the file `lpac_CoverageControl.tar.gz` to the workspace directory.

0 commit comments

Comments
 (0)