Skip to content

Commit

Permalink
minor doc update (#124)
Browse files Browse the repository at this point in the history
  • Loading branch information
rvhonorato authored Aug 15, 2024
1 parent 2710482 commit 595fa24
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
8 changes: 4 additions & 4 deletions docs/src/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,10 @@ This tool is not meant to be used by end-users who want to run a single target,
To us it simply download the latest binary from the [releases page](https://github.com/haddocking/haddock-runner/releases):

```bash
$ wget https://github.com/haddocking/haddock-runner/releases/download/v1.8.1/haddock-runner_1.8.1_linux_386.tar.gz
$ tar -zxvf haddock-runner_1.8.1_linux_386.tar.gz
$ wget https://github.com/haddocking/haddock-runner/releases/download/v1.10.0/haddock-runner_1.10.0_linux_386.tar.gz
$ tar -zxvf haddock-runner_1.10.0_linux_386.tar.gz
$ ./haddock-runner -version
haddock-runner version v1.8.1
haddock-runner version v1.10.0
```

Alternatively, you can build the latest version from source (you probably don't need to do that), make sure [go](https://go.dev/doc/install) is installed and run the following commands:
Expand All @@ -28,5 +28,5 @@ $ git clone https://github.com/haddocking/haddock-runner.git
$ cd haddock-runner
$ go build -o haddock-runner
$ ./haddock-runner -version
haddock-runner version v1.8.1
haddock-runner version v1.10.0
```
2 changes: 1 addition & 1 deletion docs/src/usage.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Usage

This chapter will go over the steps needed to use `haddock-tools`.
This chapter will go over the steps needed to use `haddock-runner`.

1. [Writing the input file list of the targets `input.list`](./setup-a-benchmark.md)
2. [Writing a `run-haddock.sh` script](./writing-a-run-haddock.sh-script.md)
Expand Down

0 comments on commit 595fa24

Please sign in to comment.