From 0092a06a0f50e74b1f69f4657679887fa8895457 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andr=C3=A9=20Videla?= Date: Fri, 15 Aug 2025 11:26:14 +0100 Subject: [PATCH 1/7] update download page with pack instructions --- src/content/pages/download.rst | 23 ++++++++--------------- 1 file changed, 8 insertions(+), 15 deletions(-) diff --git a/src/content/pages/download.rst b/src/content/pages/download.rst index 1a93a06..ce7feee 100644 --- a/src/content/pages/download.rst +++ b/src/content/pages/download.rst @@ -1,26 +1,21 @@ Download ======== +Idris 2 +------- -*IMPORTANT: The Idris website and install instructions are out of date. We are -working on rectifying this as soon as possible. In the meantime, for installing -you will likely want to use* -`pack `__, -*and for up-to-date information, please see the* -`Idris2 GitHub Repository `__. +To get the cutting edge version of the compiler, use the package manager ``pack`` – +please see `pack's install & usage instructions `_. +``pack`` will also handle your dependencies using the `pack collection `_. +You will have to use ``pack build`` instead of idris to compile. -Idris 2 -------- +If you already use ``pack``, you can update your idris version by using ``pack switch latest``. The latest released version is Idris2-0.7.0, `released 2023-12-22 <{filename}../posts/idris2-0-7-0-released.rst>`_. -You can install and use Idris 2 via either: - -* ``pack``, the package manager – please see - `pack's install instructions `_. -* The release tarball – +And its associated tarballs `idris2-0.7.0.tgz <{static}../releases/idris2-0.7.0.tgz>`_ `(SHA 256 hash) <{static}../releases/idris2-0.7.0.tgz.sha256>`__. @@ -38,8 +33,6 @@ You can always find the latest development version `on github * ``git clone`` `https://github.com/idris-lang/Idris2.git `_ -Or by switching to the ``"latest"`` package collection if using ``pack``. - Previous releases are also available: * `idris2-0.6.0.tgz <{static}../releases/idris2-0.6.0.tgz>`_ `(SHA 256 hash) <{static}../releases/idris2-0.6.0.tgz.sha256>`__ From ad7964174851a7e7a6bc9a07522b6001697074b1 Mon Sep 17 00:00:00 2001 From: "Thomas E. Hansen" Date: Tue, 19 Aug 2025 13:45:33 +0100 Subject: [PATCH 2/7] [ index ] Remove disclaimer from front page --- src/content/pages/index.rst | 11 ----------- 1 file changed, 11 deletions(-) diff --git a/src/content/pages/index.rst b/src/content/pages/index.rst index fcb271a..da25e1a 100644 --- a/src/content/pages/index.rst +++ b/src/content/pages/index.rst @@ -10,17 +10,6 @@ Idris: A Language for Type-Driven Development .. :align: right ------ - -*IMPORTANT: The Idris website and install instructions are out of date. We are -working on rectifying this as soon as possible. In the meantime, for installing -you will likely want to use* -`pack `__, -*and for up-to-date information, please see the* -`Idris2 GitHub Repository `__. - ------ - Idris is a programming language designed to encourage *Type-Driven Development*. From 2848db55525ba4e069aa2554e0e52f67a6465432 Mon Sep 17 00:00:00 2001 From: "Thomas E. Hansen" Date: Tue, 19 Aug 2025 13:46:55 +0100 Subject: [PATCH 3/7] [ download ] Clarify switch latest behaviour Using `pack switch latest` does indeed update one's installed version of Idris 2, however, it updates it to the latest git commit (the latest HEAD) and not the latest release. This is worth clarifying. --- src/content/pages/download.rst | 26 +++++++++++++++----------- 1 file changed, 15 insertions(+), 11 deletions(-) diff --git a/src/content/pages/download.rst b/src/content/pages/download.rst index ce7feee..e932fb1 100644 --- a/src/content/pages/download.rst +++ b/src/content/pages/download.rst @@ -4,23 +4,27 @@ Download Idris 2 ------- -To get the cutting edge version of the compiler, use the package manager ``pack`` – +To get the cutting edge version of Idris 2, use the package manager ``pack`` – please see `pack's install & usage instructions `_. -``pack`` will also handle your dependencies using the `pack collection `_. -You will have to use ``pack build`` instead of idris to compile. +``pack`` will also handle your dependencies using the +`pack collection `_. +You will have to use ``pack build`` instead of ``idris2 --build`` to compile a +package. -If you already use ``pack``, you can update your idris version by using ``pack switch latest``. +If you already use ``pack``, you can update your Idris version to the latest git +commit (``HEAD``) by using ``pack switch latest``. -The latest released version is Idris2-0.7.0, -`released 2023-12-22 <{filename}../posts/idris2-0-7-0-released.rst>`_. +Alternatively, the latest formally released version is Idris2-0.7.0, +`released 2023-12-22 <{filename}../posts/idris2-0-7-0-released.rst>`_, +with its associated source tarball: -And its associated tarballs - `idris2-0.7.0.tgz <{static}../releases/idris2-0.7.0.tgz>`_ - `(SHA 256 hash) <{static}../releases/idris2-0.7.0.tgz.sha256>`__. +* `idris2-0.7.0.tgz <{static}../releases/idris2-0.7.0.tgz>`_ + `(SHA 256 hash) <{static}../releases/idris2-0.7.0.tgz.sha256>`__ -Both include generated Scheme sources sufficient for bootstrapping, so you don't -need an existing Idris 2 system to build. You need: +Both ``pack`` and the release tarball include generated Scheme sources +sufficient for bootstrapping, so you don't need an existing Idris 2 system to +build. You need: * Either `Chez Scheme `_ or `Racket `_ to build the generated Scheme source From d14b27ec7fc828f74abfe7dbad851d506906a836 Mon Sep 17 00:00:00 2001 From: "Thomas E. Hansen" Date: Tue, 19 Aug 2025 15:19:28 +0100 Subject: [PATCH 4/7] [ download ] Prefer pack, mention release dates This is some larger rewording compared to the previous commit. However, it felt better to immediately point people to `pack` as the least painful install process. Mentioning that one can use releases with `pack`, but that this requires some care, also seemed sensible. --- src/content/pages/download.rst | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/src/content/pages/download.rst b/src/content/pages/download.rst index e932fb1..34d2ed4 100644 --- a/src/content/pages/download.rst +++ b/src/content/pages/download.rst @@ -4,20 +4,26 @@ Download Idris 2 ------- -To get the cutting edge version of Idris 2, use the package manager ``pack`` – +The easiest way to install and use Idris 2, is to use the package manager ``pack`` – please see `pack's install & usage instructions `_. -``pack`` will also handle your dependencies using the +This will install the cutting edge version of the compiler, as well as handle +your dependencies using the `pack collection `_. You will have to use ``pack build`` instead of ``idris2 --build`` to compile a package. If you already use ``pack``, you can update your Idris version to the latest git -commit (``HEAD``) by using ``pack switch latest``. +commit (``HEAD``) by using ``pack switch latest``. If you wish to use a specific +release with ``pack``, currently the only way to do this is to find the release +date, and then switch to its nightly collection by using, for example, +``pack switch nightly-231222`` (which would switch to the 0.7.0 release). -Alternatively, the latest formally released version is Idris2-0.7.0, +The latest formally released version is Idris2-0.7.0, `released 2023-12-22 <{filename}../posts/idris2-0-7-0-released.rst>`_, -with its associated source tarball: +with its associated source tarball, which could alternatively be used for +installation, forgoing ``pack`` (packages would have to be managed manually, via +scripts, or via other software): * `idris2-0.7.0.tgz <{static}../releases/idris2-0.7.0.tgz>`_ `(SHA 256 hash) <{static}../releases/idris2-0.7.0.tgz.sha256>`__ From 1d77a368464e20233863fa789aeb76bc1a8781b6 Mon Sep 17 00:00:00 2001 From: "Thomas E. Hansen" Date: Tue, 19 Aug 2025 15:28:45 +0100 Subject: [PATCH 5/7] [ download:ux ] Move prerequisites to top Although both `pack` and Idris2's repo mention needing Chez or Racket at some point, having this at the very start means people don't get halfway through the install procedure, only for it to then go "And what Scheme have you got installed?", which might lead to confusion and/or frustration. This way, new users will know to set up Chez Scheme or Racket first, and then return to the Idris install instructions. --- src/content/pages/download.rst | 20 +++++++++++++------- 1 file changed, 13 insertions(+), 7 deletions(-) diff --git a/src/content/pages/download.rst b/src/content/pages/download.rst index 34d2ed4..eddb153 100644 --- a/src/content/pages/download.rst +++ b/src/content/pages/download.rst @@ -1,6 +1,18 @@ Download ======== +Prerequisites +------------- + +In order to install Idris 2, you need: + +* Either `Chez Scheme `_ or + `Racket `_, to build the bootstrapping Scheme source. +* ``bash``, with ``realpath``. On Linux, you probably already have this. On + a Mac, you can install this with ``brew install coreutils``. +* A C compiler, to build the library support code. + + Idris 2 ------- @@ -30,13 +42,7 @@ scripts, or via other software): Both ``pack`` and the release tarball include generated Scheme sources sufficient for bootstrapping, so you don't need an existing Idris 2 system to -build. You need: - -* Either `Chez Scheme `_ or `Racket - `_ to build the generated Scheme source -* ``bash``, with ``realpath``. On Linux, you probably already have this. On - a Mac, you can install this with ``brew install coreutils``. -* A C compiler, to build the library support code. +build. You can always find the latest development version `on github `_: From 3c9151ce1db8aa9199bfe8ffbd9eefa8c834305a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andr=C3=A9=20Videla?= Date: Wed, 20 Aug 2025 09:41:40 +0100 Subject: [PATCH 6/7] rephrase dev version instead of git commit --- src/content/pages/download.rst | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/src/content/pages/download.rst b/src/content/pages/download.rst index eddb153..0c4a869 100644 --- a/src/content/pages/download.rst +++ b/src/content/pages/download.rst @@ -25,8 +25,8 @@ your dependencies using the You will have to use ``pack build`` instead of ``idris2 --build`` to compile a package. -If you already use ``pack``, you can update your Idris version to the latest git -commit (``HEAD``) by using ``pack switch latest``. If you wish to use a specific +If you already use ``pack``, you can update your Idris version to the latest version +in development by using ``pack switch latest``[#f1]_. If you wish to use a specific release with ``pack``, currently the only way to do this is to find the release date, and then switch to its nightly collection by using, for example, ``pack switch nightly-231222`` (which would switch to the 0.7.0 release). @@ -111,3 +111,7 @@ There are editor modes which support interactive editing: * `Vim mode (for Idris 1) `_ * `Emacs mode (for Idris 1 and 2) `_ * `(DEPRECATED) `_ `Atom package `__ + +.. rubric:: Footnotes + +.. [#f1] This version point to the latest git commit (``HEAD``) of the Idris 2 project. From fb9e630263f5fbdf2d2e90940a5816b5c98d5228 Mon Sep 17 00:00:00 2001 From: "Thomas E. Hansen" Date: Wed, 20 Aug 2025 11:31:27 +0100 Subject: [PATCH 7/7] [ fix ] Footnote ref requires spacing --- src/content/pages/download.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/src/content/pages/download.rst b/src/content/pages/download.rst index 0c4a869..9805fe8 100644 --- a/src/content/pages/download.rst +++ b/src/content/pages/download.rst @@ -26,7 +26,7 @@ You will have to use ``pack build`` instead of ``idris2 --build`` to compile a package. If you already use ``pack``, you can update your Idris version to the latest version -in development by using ``pack switch latest``[#f1]_. If you wish to use a specific +in development by using ``pack switch latest`` ([#f1]_). If you wish to use a specific release with ``pack``, currently the only way to do this is to find the release date, and then switch to its nightly collection by using, for example, ``pack switch nightly-231222`` (which would switch to the 0.7.0 release). @@ -112,6 +112,7 @@ There are editor modes which support interactive editing: * `Emacs mode (for Idris 1 and 2) `_ * `(DEPRECATED) `_ `Atom package `__ -.. rubric:: Footnotes +Footnotes +--------- .. [#f1] This version point to the latest git commit (``HEAD``) of the Idris 2 project.