Skip to content

Commit

Permalink
Updated documentation for v1.1
Browse files Browse the repository at this point in the history
  • Loading branch information
MatthewDaggitt committed Jun 29, 2019
1 parent b8700e3 commit dffb802
Show file tree
Hide file tree
Showing 6 changed files with 14 additions and 14 deletions.
6 changes: 3 additions & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Version TODO
============
Version 1.1
===========

The library has been tested using Agda version 2.6.0.
The library has been tested using Agda version 2.6.0.1.

Changes since 1.0.1:

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, development version
-- The Agda standard library, version 1.1
--
-- 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.
-- This version of the library has been tested using Agda 2.6.0.1.

-- The library comes with a .agda-lib file, for use with the library
-- management system.
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ You can browse the library source code in glorious clickable html
## Installation instructions

See the instructions [here](https://github.com/agda/agda-stdlib/blob/master/notes/installation-guide.md)
for how to install version 1.0.1 of the standard library.
for how to install version 1.1 of the standard library.

#### Old versions of Agda

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.0.1-dev
version: 1.1
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.0.1 of the standard library with Agda 2.6.0.
Use version v1.1 of the standard library with Agda 2.6.0.

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

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

6. [ OPTIONAL ] To use the standard library in your project `$PROJECT`,
Expand Down
2 changes: 1 addition & 1 deletion notes/release-guide.txt
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ procedure should be followed:

* Update `notes/installation-guide.txt`

* Finish the CHANGELOG.
* Update `CHANGELOG.md`.

* Update the copyright year range in the LICENSE file, if necessary.

Expand Down

0 comments on commit dffb802

Please sign in to comment.