Skip to content

Commit

Permalink
Update lib/README.md with instructions for opam install of VSTlib
Browse files Browse the repository at this point in the history
  • Loading branch information
andrew-appel committed Jul 20, 2023
1 parent f7b0082 commit 2888663
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion lib/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,16 @@ Additional details:
- memmgr: This is the "[Verified Sequential Malloc/Free](https://dl.acm.org/doi/10.1145/3381898.3397211)" published by Naumann and Appel.
- malloc: This is an axiomatized version of standard Posix malloc/free, for those users who want to call
the standard library implementations.

## How to install and use VSTlib
```
opam repository add coq-released
opam install coq-vst-lib
```
- For C include files, add to your CFLAGS: `-I $(OPAM_SWITCH_PREFIX)/lib/coq/user-contrib/VSTlib/include`
- For C sources to compile and link with: `$(OPAM_SWITCH_PREFIX)/lib/coq/user-contrib/VSTlib/src`
- Within Coq: `From VSTlib Require Import spec_malloc.` (* etc *)

(Instead of opam, you could build from sources and do `make install`, and adjust your paths to `lib/coq/user-contrib' appropriately.)
## Testing and demonstration examples

Example clients that demonstrate how to use these VSUs can be found
Expand Down

0 comments on commit 2888663

Please sign in to comment.