Skip to content

Commit 4998f5e

Browse files
committed
Update readme: add quick dependencies instructions
1 parent 1c63af7 commit 4998f5e

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,26 @@ An Experimental Asynchronous Proramming Library for Scala 3. It aims to be:
1616
The [Gears Book](https://natsukagami.github.io/gears-book) is a great way to getting started with programming using Gears.
1717
It provides a tutorial, as well as a guided walkthrough of all concepts available within Gears.
1818

19+
### Adding `gears` to your dependencies
20+
21+
With `sbt`:
22+
```scala
23+
libraryDependencies += "ch.epfl.lamp" %%% "gears" % "<version>",
24+
```
25+
26+
With `mill`:
27+
```scala
28+
def ivyDeps = Agg(
29+
// ... other dependencies
30+
ivy"ch.epfl.lamp:::gears::<version>"
31+
)
32+
```
33+
34+
With `scala` (since 3.5.0) or `scala-cli`:
35+
```scala
36+
//> using dep "ch.epfl.lamp:::gears::<version>"
37+
```
38+
1939
## Setting up on an unpublished version of Gears
2040

2141
You will need JDK >= 21 and [Scala Native](https://scala-native.org) set up.

0 commit comments

Comments
 (0)