diff --git a/README.md b/README.md index 686c93df..7555a68f 100644 --- a/README.md +++ b/README.md @@ -7,17 +7,15 @@ Ergo (formerly known as Oragono) is a modern IRC server written in Go. Its core * Bleeding-edge [IRCv3 support](https://ircv3.net/software/servers.html), suitable for use as an IRCv3 reference implementation * High customizability via a rehashable (i.e., reloadable at runtime) YAML config -Ergo is a fork of the [Ergonomadic](https://github.com/jlatt/ergonomadic) IRC daemon <3 +For more detailed information on Ergo's functionality, see: ---- - -[![Go Report Card](https://goreportcard.com/badge/github.com/ergochat/ergo)](https://goreportcard.com/report/github.com/ergochat/ergo) -[![build](https://github.com/ergochat/ergo/actions/workflows/build.yml/badge.svg)](https://github.com/ergochat/ergo/actions/workflows/build.yml) -[![Download Latest Release](https://img.shields.io/badge/downloads-latest%20release-green.svg)](https://github.com/ergochat/ergo/releases/latest) -[![Crowdin](https://d322cqt584bo4o.cloudfront.net/ergochat/localized.svg)](https://crowdin.com/project/ergochat) +* [USERGUIDE.md, the guide for end users](https://github.com/ergochat/ergo/blob/stable/docs/USERGUIDE.md) +* [MANUAL.md, the operator manual](https://github.com/ergochat/ergo/blob/stable/docs/MANUAL.md) If you want to take a look at a running Ergo instance or test some client code, feel free to play with [testnet.ergo.chat](https://testnet.ergo.chat/) (TLS on port 6697 or plaintext on port 6667). +Ergo is a fork of the [Ergonomadic](https://github.com/jlatt/ergonomadic) IRC daemon <3 + --- @@ -41,10 +39,6 @@ If you want to take a look at a running Ergo instance or test some client code, * `UBAN`, a unified ban system that can target IPs, networks, masks, and registered accounts (`KLINE` and `DLINE` are also supported) * a focus on developing with [specifications](https://ergo.chat/specs.html) -For more detailed information on Ergo's functionality, see: - -* [MANUAL.md, the operator manual](https://github.com/ergochat/ergo/blob/stable/docs/MANUAL.md) -* [USERGUIDE.md, the guide for end users](https://github.com/ergochat/ergo/blob/stable/docs/USERGUIDE.md) ## Quick start guide diff --git a/docs/BUILD.md b/docs/BUILD.md index 54604c96..ea12e6ae 100644 --- a/docs/BUILD.md +++ b/docs/BUILD.md @@ -19,7 +19,7 @@ This guide is for building Ergo from source. You can also obtain a pre-built rel You will need an [up-to-date distribution of the Go language for your OS and architecture](https://golang.org/dl/). Use the latest version available. (As of this writing, only Google's Go distribution is supported, since `gccgo` lacks support for current language features.) Check the output of `go version` to ensure it was installed correctly. -You will need to either clone the repository from GitHub at [https://github.com/ergochat/ergo], or obtain a source tarball from our releases page on GitHub. +You will need to either clone the repository from GitHub at https://github.com/ergochat/ergo, or obtain a source tarball from our releases page on GitHub. # What to build