]> jfr.im git - solanum.git/blobdiff - README.md
Add ^ marker to stats l,L
[solanum.git] / README.md
index 1904136b145af8638c4c0f2a4992722959b7c917..9bb672f6c694357ff66fc17253b866f9f4da41c7 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,10 +1,10 @@
-# solanum [![Build Status](https://travis-ci.com/solanum-ircd/solanum.svg?branch=main)](https://travis-ci.com/solanum-ircd/solanum)
+# solanum ![Build Status](https://github.com/solanum-ircd/solanum/workflows/CI/badge.svg)
 
 Solanum is an IRCv3 server designed to be highly scalable.  It implements IRCv3.1 and some parts of IRCv3.2.
 
 It is meant to be used with an IRCv3-capable services implementation such as [Atheme][atheme] or [Anope][anope].
 
-   [atheme]: http://www.atheme.net/
+   [atheme]: https://atheme.github.io/
    [anope]: http://www.anope.org/
 
 # necessary requirements
@@ -60,10 +60,10 @@ These are known issues and workarounds for supported platforms.
 
  * **FreeBSD**: if you are compiling with ipv6 you may experience
    problems with ipv4 due to the way the socket code is written.  To
-   fix this you must: "sysctl net.inet6.ip6.v6only=0"
+   fix this you must: `sysctl net.inet6.ip6.v6only=0`
 
- * **Solaris**: you may have to set your PATH to include /usr/gnu/bin and /usr/gnu/sbin before /usr/bin
-   and /usr/sbin. Solaris's default tools don't seem to play nicely with the configure script.
+ * **Solaris**: you may have to set your `PATH` to include `/usr/gnu/bin` and `/usr/gnu/sbin` before `/usr/bin`
+   and `/usr/sbin`. Solaris's default tools don't seem to play nicely with the configure script.
 
 # building
 
@@ -81,10 +81,10 @@ See `./configure --help` for build options.
 
  * For SSL/TLS client and server connections, one of:
 
-   * OpenSSL 1.0.0 or newer (--enable-openssl)
-   * LibreSSL (--enable-openssl)
-   * mbedTLS (--enable-mbedtls)
-   * GnuTLS (--enable-gnutls)
+   * OpenSSL 1.0.0 or newer (`--enable-openssl`)
+   * LibreSSL (`--enable-openssl`)
+   * mbedTLS (`--enable-mbedtls`)
+   * GnuTLS (`--enable-gnutls`)
 
  * For certificate-based oper CHALLENGE, OpenSSL 1.0.0 or newer.
    (Using CHALLENGE is not recommended for new deployments, so if you want to use a different TLS library,
@@ -96,16 +96,16 @@ See `./configure --help` for build options.
 
 # tips
 
- * To report bugs in solanum, visit us at chat.freenode.net #solanum
+ * To report bugs in Solanum, visit us at `#solanum` on [Libera Chat](https://libera.chat)
 
- * Please read doc/index.txt to get an overview of the current documentation.
+ * Please read [doc/index.txt](doc/index.txt) to get an overview of the current documentation.
 
- * Read the NEWS file for what's new in this release.
+ * Read the [NEWS.md](NEWS.md) file for what's new in this release.
 
- * The files, /etc/services, /etc/protocols, and /etc/resolv.conf, SHOULD be
+ * The files, `/etc/services`, `/etc/protocols`, and `/etc/resolv.conf`, SHOULD be
    readable by the user running the server in order for ircd to start with
-   the correct settings.  If these files are wrong, solanum will try to use
-   127.0.0.1 for a resolver as a last-ditch effort.
+   the correct settings.  If these files are wrong, Solanum will try to use
+   `127.0.0.1` for a resolver as a last-ditch effort.
 
 # git access