Skip to content

Commit 4c5dd7b

Browse files
authored
Mention RootProject alternative to jitpack
1 parent 92ef76f commit 4c5dd7b

File tree

1 file changed

+28
-4
lines changed

1 file changed

+28
-4
lines changed

README.md

Lines changed: 28 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,17 +17,41 @@ information, see:
1717
- A more detailed description of the available solver/evaluator [API](doc/API.md) calls.
1818
- A description of the [trees](doc/trees.md) API and how to extend them.
1919

20-
To import Inox into your project, add the following lines to your `build.sbt`:
20+
### Add Inox as a dependency
2121

22-
```scala
22+
To add Inox as a dependency of your project, add the following lines to your `build.sbt`,
23+
where `VERSION` can be replaced by a tag (eg. `v1.1.5`), a branch name (eg. `rust-interop`)
24+
or a commit hash (eg. `6dfb351eee`).
2325

26+
```scala
2427
resolvers += "jitpack" at "https://jitpack.io"
2528
resolvers += "uuverifiers" at "http://logicrunch.it.uu.se:4096/~wv/maven"
2629

27-
libraryDependencies += "com.github.epfl-lara" % "inox" % "6dfb351eee"
30+
libraryDependencies += "com.github.epfl-lara" % "inox" % "VERSION"
31+
```
32+
33+
Please see the [releases page](https://github.com/epfl-lara/inox/releases) for the latest Inox release.
34+
35+
**Use without the jitpack.io resolver**
36+
37+
Alternatively, one can depend on Inox without using the [jitpack.io](jitpack.io) resolver
38+
in the following way:
39+
40+
```scala
41+
resolvers += "uuverifiers" at "http://logicrunch.it.uu.se:4096/~wv/maven"
42+
43+
def ghProject(repo: String, version: String) = RootProject(uri(s"${repo}#${version}"))
44+
45+
lazy val inox = ghProject(
46+
"https://github.com/epfl-lara/inox.git",
47+
"6dfb351eeee44a3f13152bf510aceba7936d0e4d"
48+
)
2849
```
2950

30-
Alternatively, one can use Inox through command-line by using the [TIP](https://tip-org.github.io/) format
51+
Command-line Interface
52+
----------------------
53+
54+
One can also use Inox through command-line by using the [TIP](https://tip-org.github.io/) format
3155
to describe the relevant query. The easiest way to use the Inox command line is to simply
3256
[build](#building-inox) the project and use the generated script.
3357

0 commit comments

Comments
 (0)