Skip to content

Commit

Permalink
Update installation instructions
Browse files Browse the repository at this point in the history
Signed-off-by: Kakadu <Kakadu@pm.me>
  • Loading branch information
Kakadu committed Aug 30, 2023
1 parent 0e53149 commit b537c3c
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 8 deletions.
3 changes: 2 additions & 1 deletion .github/workflows/master.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@ name: Build master
on:
push:
paths-ignore:
- 'papers/**'
- 'doc/**'
- README.md
# do not run CI if we are writing a paper
# https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#example-ignoring-paths
branches:
Expand Down
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,8 @@ into [OCaml](http://ocaml.org). Nowadays, the implementation of `OCanren` strong
Previous implementation was based on [microKanren](http://webyrd.net/scheme-2013/papers/HemannMuKanren2013.pdf)
with [disequality constraints](http://scheme2011.ucombinator.org/papers/Alvis2011.pdf).

See [installation instructions](#installation-via-opam), [API documentation](https://PLTools.github.io/OCanren/api/) for more details, and [ReadTheDocs](https://ocanren.rtfd.io/) for detailed information. (All papers about OCanren are not located in the [separate repo](https://github.com/PLTools/papers).)
See [installation instructions](https://ocanren.readthedocs.io/en/latest/Installation.html#installation),
[API documentation](https://PLTools.github.io/OCanren/api/) for more details, or [ReadTheDocs](https://ocanren.rtfd.io/) for detailed information. (All papers about OCanren are not located in the [separate repo](https://github.com/PLTools/papers).)

Check our [template repository for OCanren projects](https://github.com/Kakadu/OCanren-basic-template) for faster startup!

Expand Down
12 changes: 6 additions & 6 deletions doc/Installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,18 @@ OCanren can be installed using `opam <https://opam.ocaml.org/doc/Install.html>`_
install opam itself, initialize it and install right compiler version.

* ``opam init --bare`` if your opam has not been initialized before
* ``opam switch create 4.14.0 --packages=ocaml-variants.4.14.0+options,ocaml-option-flambda`` installes right compiler. (4.14.0 is a custom switch identifier)
* ``eval $(opam env)`` updates an environment. Opam should write invocation of this command to your ``/.bashrc``
* ``opam switch create 4.14.1 --packages=ocaml-variants.4.14.0+options,ocaml-option-flambda`` installes right compiler. (4.14.1 is a custom switch identifier)
* ``eval $(opam env)`` updates an environment. Opam will put the invocation of this command to your ``~/.bashrc``.
* check that ``ocamlc -v`` prints right compiler version

Then, install dependencies and ``OCanren``:


* Install GT (pick one command)
* ``opam install GT -y`` to install GT from opam repository.
* ``opam pin add GT https://github.com/JetBrains-Research/GT.git -n -y`` for fresh GT.
* ``git clone https://github.com/JetBrains-Research/OCanren.git``
* ``git clone https://github.com/PLTools/OCanren.git``
* ``cd OCanren``
* Install GT dependency (pick one command)
* ``git clone https://github.com/PLTools/GT.git`` to use GT as a vendored library.
* ``opam install GT -y`` to install GT from the main opam repository.
* ``opam install . --deps-only --yes``
* ``make``
* ``make tests``
Expand Down

0 comments on commit b537c3c

Please sign in to comment.