Skip to content

Commit 87a9241

Browse files
committed
Update README: Rearrange sections for clarity and improve project setup instructions
1 parent 90753df commit 87a9241

1 file changed

Lines changed: 8 additions & 9 deletions

File tree

README.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,20 @@
11
# Offroad
22
![Build](https://github.com/radevgit/offroad/actions/workflows/rust.yml/badge.svg)
33

4-
## 2D offsetting for arc polylines/polygons
4+
## Adding the library to your project
55

6+
To use the Offroad library in your project, add the following to your `Cargo.toml`:
67

8+
```toml
9+
[dependencies]
10+
offroad = "0.0.5"
11+
```
712

13+
## 2D offsetting for arc polylines/polygons
814
![](https://raw.githubusercontent.com/radevgit/offroad/refs/heads/main/img/offsets.svg "arc-line polygon offsets")
915

1016

11-
## Status
12-
13-
Currently, the library is in active development and may not yet be feature-complete.
14-
15-
It is already useful to produce "soup of arcs" when polyline is provided.
16-
The arcs are not ordered however.
17-
1817
## Examples
1918

20-
Check the examples directory for usage.
19+
Check "examples" directory for more usage examples.
2120

0 commit comments

Comments
 (0)