Skip to content

Commit 8bce812

Browse files
committed
docs: link to static binary
1 parent 118b51d commit 8bce812

File tree

1 file changed

+13
-5
lines changed

1 file changed

+13
-5
lines changed

docs/source/installation.rst

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,18 @@
11
Installation
22
============
33

4-
From source
5-
------------
4+
Static binary
5+
-------------
66

7-
There is no distribution yet, so you have to compile Narya yourself. This requires a recent version of OCaml and various libraries. Currently Narya is developed with OCaml 5.3.0; as far as I know, it also compiles with any version after 5.2.1, but this is not regularly verified. The steps to compile Narya are:
7+
A statically compiled binary, built automatically from the up-to-date development version, can be downloaded from `GitHub Pages <https://gwaithimirdain.github.io/narya/releases/narya-master-static.tar.gz>`_. This ought to work on any Linux computer, and might work on other operating systems as well (e.g. using `Windows Subsystem for Linux <https://learn.microsoft.com/en-us/windows/wsl/install>`_ on Windows). Please report your experiences!
8+
9+
You will still need to manually install Emacs, ProofGeneral, and the Narya :ref:`ProofGeneral mode`. The static distribution includes the necessary Emacs Lisp files and instructions.
10+
11+
12+
Compiling from source
13+
---------------------
14+
15+
If the static binary does not work for you, or if you want to edit the Narya code, you will have to compile it yourself. This requires a recent version of OCaml and various libraries. Currently Narya is developed with OCaml 5.3.0; as far as I know, it also compiles with any version after 5.2.1, but this is not regularly verified. The steps to compile Narya are:
816

917
1. Install `OCaml <https://ocaml.org/>`_ and its package manager `Opam <https://opam.ocaml.org/>`_. How to do this this may vary depending on your operating system.
1018

@@ -57,11 +65,11 @@ With nix
5765

5866
Narya can also be developed and installed with nix.
5967

60-
1. Get a version of nix with `flakes<https://nixos.wiki/wiki/flakes>`_ enabled, for instance via `determinate nix<https://github.com/DeterminateSystems/nix-installer>`_.
68+
1. Get a version of nix with `flakes <https://nixos.wiki/wiki/flakes>`_ enabled, for instance via `determinate nix <https://github.com/DeterminateSystems/nix-installer>`_.
6169

6270
2. Run ``nix develop`` to open a shell with all of the necessary dependencies for running ``dune build``. This may ask if you accept using a cache; you can say yes if you want to speed up the build process, or no if you want everything built on your own machine.
6371

64-
3. Run ``nix build`` to build via nix, which on linux will create a static executable that can be copied over to other linux machines without problems.
72+
3. Run ``nix build`` to build via nix. On Linux, this will create a static executable that can be copied over to other Linux machines without problems.
6573

6674
ProofGeneral (Emacs) mode
6775
-------------------------

0 commit comments

Comments
 (0)