Skip to content

Commit

Permalink
Updated documentation for v1.5
Browse files Browse the repository at this point in the history
  • Loading branch information
MatthewDaggitt committed Jan 24, 2021
1 parent f0c53d6 commit 5049a2a
Show file tree
Hide file tree
Showing 6 changed files with 12 additions and 12 deletions.
4 changes: 2 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Version 1.5-dev
===============
Version 1.5
===========

The library has been tested using Agda 2.6.1 and 2.6.1.1.

Expand Down
2 changes: 1 addition & 1 deletion LICENCE
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Copyright (c) 2007-2020 Nils Anders Danielsson, Ulf Norell, Shin-Cheng
Copyright (c) 2007-2021 Nils Anders Danielsson, Ulf Norell, Shin-Cheng
Mu, Bradley Hardy, Samuel Bronson, Dan Doel, Patrik Jansson,
Liang-Ting Chen, Jean-Philippe Bernardy, Andrés Sicard-Ramírez,
Nicolas Pouillard, Darin Morrison, Peter Berry, Daniel Brown,
Expand Down
2 changes: 1 addition & 1 deletion README.agda
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
module README where

------------------------------------------------------------------------
-- The Agda standard library, version 1.5-dev
-- The Agda standard library, version 1.5
--
-- Authors: Nils Anders Danielsson, Matthew Daggitt, Guillaume Allais
-- with contributions from Andreas Abel, Stevan Andjelkovic,
Expand Down
2 changes: 1 addition & 1 deletion agda-stdlib-utils.cabal
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name: agda-stdlib-utils
version: 1.5-dev
version: 1.5
cabal-version: >= 1.10
build-type: Simple
description: Helper programs.
Expand Down
12 changes: 6 additions & 6 deletions notes/installation-guide.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
Installation instructions
=========================

Use version v1.4 of the standard library with Agda 2.6.1 and 2.6.1.1.
Use version v1.5 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.4 of the standard library. This can either be
2. Download the tarball of v1.5 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.4.tar.gz
wget -O agda-stdlib.tar https://github.com/agda/agda-stdlib/archive/v1.5.tar.gz
```
Note that you can replace `wget` with other popular tools such as `curl` and that
you can replace `1.4` with any other version of the library you desire.
you can replace `1.5` 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:
Expand All @@ -24,14 +24,14 @@ Use version v1.4 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.4
cd agda-stdlib-1.5
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.4/standard-library.agda-lib
$HERE/agda-stdlib-1.5/standard-library.agda-lib
```

Now, the standard library is ready to be used either:
Expand Down
2 changes: 1 addition & 1 deletion notes/release-guide.txt
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ procedure should be followed:

* Update `README.md`

* Update `lib.cabal` version to `X.Y`.
* Update `agda-stdlib-utils.cabal` version to `X.Y`.

* Update the version in standard-library.agda-lib to `X.Y`

Expand Down

0 comments on commit 5049a2a

Please sign in to comment.