From 2f0fb515271fa1a01a5c55b9cf5d401c5c65aa37 Mon Sep 17 00:00:00 2001 From: = Date: Thu, 22 Apr 2021 10:11:49 +0800 Subject: [PATCH] Updated documentation for v1.6 release --- CHANGELOG.md | 15 ++++++++------- README.agda | 2 +- agda-stdlib-utils.cabal | 2 +- notes/installation-guide.md | 12 ++++++------ 4 files changed, 16 insertions(+), 15 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 7562b48645..52f9c4021a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,22 +1,23 @@ -Version 1.6-dev -=============== +Version 1.6 +=========== The library has been tested using Agda 2.6.1 and 2.6.1.3. Highlights ---------- -* Drastically reorganised the module hierarchy in the dependency graph of - the `IO` module so that we may compile a program as simple as hello world - without pulling upwards of 130 modules. +* Reorganised module hierarchy in the dependency graph of + the `IO` module so that a program as simple as "Hello world" may be + compiled without pulling upwards of 130 modules. * First verified implementation of a sorting algorithm (available from `Data.List.Sort`). * Pseudo random generators for ℕ (available from `Data.Nat.Pseudorandom.LCG`) -* Large increase in the number of proofs about both normalised and unnormalised rational numbers. +* Drastic increase in performance of normalised rational numbers. + +* Large number of additional proofs about both normalised and unnormalised rational numbers. -* Drastically increased performance of normalised rational numbers. Bug-fixes --------- diff --git a/README.agda b/README.agda index 1b95f55f79..b8ca3a6774 100644 --- a/README.agda +++ b/README.agda @@ -1,7 +1,7 @@ module README where ------------------------------------------------------------------------ --- The Agda standard library, version 1.6-dev +-- The Agda standard library, version 1.6 -- -- Authors: Nils Anders Danielsson, Matthew Daggitt, Guillaume Allais -- with contributions from Andreas Abel, Stevan Andjelkovic, diff --git a/agda-stdlib-utils.cabal b/agda-stdlib-utils.cabal index f0e03fd9e4..c6975ffd6b 100644 --- a/agda-stdlib-utils.cabal +++ b/agda-stdlib-utils.cabal @@ -1,5 +1,5 @@ name: agda-stdlib-utils -version: 1.6-dev +version: 1.6 cabal-version: >= 1.10 build-type: Simple description: Helper programs. diff --git a/notes/installation-guide.md b/notes/installation-guide.md index 802f81f465..48e8e41adc 100644 --- a/notes/installation-guide.md +++ b/notes/installation-guide.md @@ -1,19 +1,19 @@ Installation instructions ========================= -Use version v1.5 of the standard library with Agda 2.6.1 and 2.6.1.1. +Use version v1.6 of the standard library with Agda 2.6.1 and 2.6.1.1. 1. Navigate to a suitable directory `$HERE` (replace appropriately) where you would like to install the library. -2. Download the tarball of v1.5 of the standard library. This can either be +2. Download the tarball of v1.6 of the standard library. This can either be done manually by visiting the Github repository for the library, or via the command line as follows: ``` - wget -O agda-stdlib.tar https://github.com/agda/agda-stdlib/archive/v1.5.tar.gz + wget -O agda-stdlib.tar https://github.com/agda/agda-stdlib/archive/v1.6.tar.gz ``` Note that you can replace `wget` with other popular tools such as `curl` and that - you can replace `1.5` with any other version of the library you desire. + you can replace `1.6` with any other version of the library you desire. 3. Extract the standard library from the tarball. Again this can either be done manually or via the command line as follows: @@ -24,14 +24,14 @@ Use version v1.5 of the standard library with Agda 2.6.1 and 2.6.1.1. 4. [ OPTIONAL ] If using [cabal](https://www.haskell.org/cabal/) then run the commands to install via cabal: ``` - cd agda-stdlib-1.5 + cd agda-stdlib-1.6 cabal install ``` 5. Register the standard library with Agda's package system by adding the following line to `$HOME/.agda/libraries`: ``` - $HERE/agda-stdlib-1.5/standard-library.agda-lib + $HERE/agda-stdlib-1.6/standard-library.agda-lib ``` Now, the standard library is ready to be used either: