Skip to content

Commit

Permalink
Merge pull request #32 from inQWIRE/update-readme
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
caldwellb authored Feb 7, 2023
2 parents 9585279 + 0747eb6 commit e6326a2
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,18 @@ Stable versions of QuantumLib may be installed using `opam install coq-quantumli

## Using With Other Projects

To install QuantumLib, run `opam pin coq-quantumlib https://github.com/inQWIRE/QuantumLib.git`. This should allow you to import QuantumLib files into other Coq files. To pull subsequent updates, run `opam install coq-quantumlib`. When importing/exporting specific files, refer to QuantumLib files as `QuantumLib.FILENAME`.
### Official Release

To install the official release of QuantumLib, run the following.
```
opam repo add coq-released https://coq.inria.fr/opam/released
opam update
opam install coq-quantumlib
```

### Dev

To install the development version of QuantumLib, run `opam pin coq-quantumlib https://github.com/inQWIRE/QuantumLib.git`. This should allow you to import QuantumLib files into other Coq files. To pull subsequent updates, run `opam install coq-quantumlib`. When importing/exporting specific files, refer to QuantumLib files as `QuantumLib.FILENAME`.

## Directory Contents

Expand Down

0 comments on commit e6326a2

Please sign in to comment.