Skip to content

Commit

Permalink
readme: Improve the docs
Browse files Browse the repository at this point in the history
Golang modules make things a mess.
  • Loading branch information
purpleidea committed May 15, 2021
1 parent b1bcd33 commit a6dbab1
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,28 @@ packaging. You'll also need the C headers for `libc` which can be obtained by
installing the `glibc-headers` package in the "redhat" family, or the
`libc6-dev` package in the "debian" family.

The easiest way to get all the dependencies is to run:

```bash
./misc/make-deps.sh
```

If you get some errors like:

```
package _/root/ircdns: unrecognized import path "_/root/ircdns": import path does not begin with hostname
package _/root/ircdns/client: unrecognized import path "_/root/ircdns/client": import path does not begin with hostname
```

at the end of running this script then run:

```shell
go mod init ircdns
go get -u ./...
```

and then you should be able to `make` safely.

## Server usage:

You can install it with:
Expand Down

0 comments on commit a6dbab1

Please sign in to comment.