Skip to content

Commit b778ef8

Browse files
committed
Linked the other README files
1 parent 40214a4 commit b778ef8

File tree

1 file changed

+11
-8
lines changed

1 file changed

+11
-8
lines changed

README.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,15 @@
33

44
# Environment Setup
55

6-
NOTE: An easy way to get Code2Inv up and running is to build it using the Dockerfile we have provided.
6+
## Using the Docker Container
7+
8+
An easy way to get Code2Inv up and running is to build it using the Dockerfile we have provided.
79

810
You can either pull the docker image from our dockerhub repo:
911
```
1012
docker pull code2inv/code2inv
1113
```
1214

13-
Or you can build the docker container:
14-
```
15-
$ docker build -t code2inv/code2inv docker/
16-
```
17-
1815
This should create an image called `code2inv/code2inv`. To see all the docker images, run
1916
```
2017
$ docker images
@@ -27,6 +24,12 @@ $ docker run -it --name code2inv code2inv/code2inv
2724

2825
This should open a docker container with all code2inv setup completed.
2926

27+
If you want to build the docker container yourself, run:
28+
```
29+
$ docker build -t code2inv/code2inv docker/
30+
```
31+
which should create a docker image named code2inv/code2inv.
32+
3033
## Basic Setup
3134
The following are needed for running the basic setup
3235
- python-3.7
@@ -46,9 +49,9 @@ Remember to set environment variables `LD_LIBRARY_PATH` and `PYTHONPATH` to cont
4649
## Frontend Setup (Optional)
4750
There are two frontends, one each for the C and CHC instances. The C frontend is called clang-fe and can be found in the `clang-fe/` directory. The CHC frontend is called chc-fe and is located in the `chc-fe/` directory. These frontends have limited support and are tested with the benchmarks included. Primarily, they can be used with programs containing single loops.
4851

49-
The `clang-fe` frontend is used to extract program graphs and verification conditions (VCs) from the input C programs. This will be a necessary step if you wish to run Code2Inv on a C file which isn't in the benchmarks. The program graphs and VCs for our benchmarks are already included in the `benchmarks/C_instances` directory and the same for the Non Linear benchmarks are included in the `benchmarks/nl-bench/` directory. To build the frontend, follow the instructions in README in `clang-fe`.
52+
The `clang-fe` frontend is used to extract program graphs and verification conditions (VCs) from the input C programs. This will be a necessary step if you wish to run Code2Inv on a C file which isn't in the benchmarks. The program graphs and VCs for our benchmarks are already included in the `benchmarks/C_instances` directory and the same for the Non Linear benchmarks are included in the `benchmarks/nl-bench/` directory. To build the frontend, follow the instructions in [README](clang-fe/README.md) in `clang-fe`.
5053

51-
The `chc-fe` frontend is used to extract program graphs from the input CHC programs (the CHC constraints themselves serve as the verification conditions (VCs)). This will be necessary to run Code2Inv for constraints not included in the benchmarks. The graphs and the VCs are already included in the `benchmarks/CHC_instances` directory. To run the CHC frontend, follow the instructions in README in `chc-fe`.
54+
The `chc-fe` frontend is used to extract program graphs from the input CHC programs (the CHC constraints themselves serve as the verification conditions (VCs)). This will be necessary to run Code2Inv for constraints not included in the benchmarks. The graphs and the VCs are already included in the `benchmarks/CHC_instances` directory. To run the CHC frontend, follow the instructions in [README](chc-fe/README) in `chc-fe`.
5255

5356
# Experiments
5457

0 commit comments

Comments
 (0)