Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update installation instructions #2512

Merged
merged 1 commit into from
Dec 9, 2024
Merged

Update installation instructions #2512

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 10 additions & 8 deletions doc/installation-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,15 @@ Use version v2.1.1 of the standard library with Agda 2.7.0. You can find the cor
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/v2.1.1.tar.gz
wget -O agda-stdlib.tar.gz https://github.com/agda/agda-stdlib/archive/v2.1.1.tar.gz
```
Note that you can replace `wget` with other popular tools such as `curl` and that
you can replace `2.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:
```
tar -zxvf agda-stdlib.tar
tar -zxvf agda-stdlib.tar.gz
```

4. [ OPTIONAL ] If using [cabal](https://www.haskell.org/cabal/) then run
Expand All @@ -30,15 +30,17 @@ Use version v2.1.1 of the standard library with Agda 2.7.0. You can find the cor
cabal install
```

5. Locate the file `$HOME/.agda/libraries` where `$HOME` on Ubuntu/MacOS
is an environment variable that points to your home directory. The
value of the environment variable can be found by running `echo $HOME`.
5. Locate the file `$AGDA_DIR/libraries` where `$AGDA_DIR` on Ubuntu/MacOS
can be found by running `agda --print-agda-app-dir`.

Note that the `.agda` directory and the `libraries` file within it,
Full details, including the various possible locations that `$AGDA_DIR`
might map to, may be found in [the online documentation](https://agda.readthedocs.io/en/latest/tools/package-system.html#installing-libraries).

Note that the `$AGDA_DIR` directory and the `libraries` file within it,
may not exist and you may have to create them.

6. Register the standard library with Agda's package system by adding
the following line to `$HOME/.agda/libraries`:
the following line to `$AGDA_DIR/libraries`:
```
$HERE/agda-stdlib-2.1.1/standard-library.agda-lib
```
Expand All @@ -55,7 +57,7 @@ Now, the standard library is ready to be used either:
searches for modules, for instance `.` (just the project's root).

- in all your projects, by adding the following line to
`$HOME/.agda/defaults`
`$AGDA_DIR/defaults`
```
standard-library
```
Loading