Skip to content

Commit

Permalink
Updated documentation for v1.3 release
Browse files Browse the repository at this point in the history
  • Loading branch information
MatthewDaggitt committed Mar 16, 2020
1 parent fcef696 commit 9f929b4
Show file tree
Hide file tree
Showing 6 changed files with 13 additions and 17 deletions.
6 changes: 3 additions & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Version 1.3-dev
===============
Version 1.3
===========

The library has been tested using Agda version 2.6.1 release candidate 2.
The library has been tested using Agda version 2.6.1.

Highlights
----------
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-2019 Nils Anders Danielsson, Ulf Norell, Shin-Cheng
Copyright (c) 2007-2020 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
4 changes: 2 additions & 2 deletions 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.3-dev
-- The Agda standard library, version 1.3
--
-- Authors: Nils Anders Danielsson, Matthew Daggitt, Guillaume Allais
-- with contributions from Andreas Abel, Stevan Andjelkovic,
Expand All @@ -16,7 +16,7 @@ module README where
-- Noam Zeilberger and other anonymous contributors.
------------------------------------------------------------------------

-- This version of the library has been tested using Agda 2.6.0.1.
-- This version of the library has been tested using Agda 2.6.1.

-- The library comes with a .agda-lib file, for use with the library
-- management system.
Expand Down
4 changes: 0 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,6 @@
The Agda standard library
=========================

**PLEASE NOTE**: due to the imminent release of Agda 2.6.1, both the `master`
and the `experimental` branches currently require the latest development
version of Agda.

The standard library aims to contain all the tools needed to write both
programs and proofs easily. While we always try and write efficient
code, we prioritize ease of proof over type-checking and normalization
Expand Down
2 changes: 1 addition & 1 deletion lib.cabal
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name: lib
version: 1.3-dev
version: 1.3
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.2 of the standard library with Agda 2.6.0.1.
Use version v1.3 of the standard library with Agda 2.6.1.

1. Navigate to a suitable directory `$HERE` (replace appropriately) where
you would like to install the library.

2. Download the tarball of v1.2 of the standard library. This can either be
2. Download the tarball of v1.3 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.2.tar.gz
wget -O agda-stdlib.tar https://github.com/agda/agda-stdlib/archive/v1.3.tar.gz
```
Note that you can replace `wget` with other popular tools such as `curl` and that
you can replace `1.2` with any other version of the library you desire.
you can replace `1.3` 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.2 of the standard library with Agda 2.6.0.1.
4. [ OPTIONAL ] If using [cabal](https://www.haskell.org/cabal/) then run
the commands to install via cabal:
```
cd agda-stdlib-1.2
cd agda-stdlib-1.3
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.2/standard-library.agda-lib
$HERE/agda-stdlib-1.3/standard-library.agda-lib
```

6. [ OPTIONAL ] To use the standard library in your project `$PROJECT`,
Expand Down

0 comments on commit 9f929b4

Please sign in to comment.