Skip to content

Commit

Permalink
readme: add instructions to install package with opam
Browse files Browse the repository at this point in the history
This is necessary to compile OCaml projects dependent on aslp.
  • Loading branch information
katrinafyi authored Jun 27, 2024
1 parent 44de990 commit b779135
Showing 1 changed file with 15 additions and 2 deletions.
17 changes: 15 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ This interpreter consists of a single directory organized as follows
### Installing with Nix

ASLp can be installed as a Nix package from https://github.com/katrinafyi/pac-nix.
_asli_ provides the base ASLp and _aslp_ provides ASLp bundled with ARM's specifications.
The _aslp_ provides ASLp bundled with ARM's specifications.
If you don't plan on modifying the tool, this is a fast and easy way to get started.

### Installing dependencies
Expand Down Expand Up @@ -123,13 +123,26 @@ You also need to execute this command

To build the ASL lexer and ASL interpreter, execute this command.

```
```
make install
```

If you get a lot of linker errors involving Z3, double-check that you installed
the right version.

### Building for use in other projects

If you need to use ASLp or libASL in a downstream OCaml project,
these steps will install the package in a location discoverable by opam and dune.

After installing dependencies and testing the build, run these commands in this directory:
```
opam pin . -k path
opam install .
```
Once complete, you can verify the package is installed by running `ocamlfind query asli`.


### Using ASL lexer

This displays a list of tokens in an ASL file including the indent
Expand Down

0 comments on commit b779135

Please sign in to comment.