summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorAnton Luka Šijanec <anton@sijanec.eu>2021-07-13 18:43:45 +0200
committerAnton Luka Šijanec <anton@sijanec.eu>2021-07-13 18:43:45 +0200
commit1b311510f7ef342e4de24d6331a22ca4fc68c071 (patch)
treefb6ca489fcbbdfa4135224bcb02dc2c15b615876 /README.md
parentremoved useless dependency: math (diff)
downloaddiscord.c-1b311510f7ef342e4de24d6331a22ca4fc68c071.tar
discord.c-1b311510f7ef342e4de24d6331a22ca4fc68c071.tar.gz
discord.c-1b311510f7ef342e4de24d6331a22ca4fc68c071.tar.bz2
discord.c-1b311510f7ef342e4de24d6331a22ca4fc68c071.tar.lz
discord.c-1b311510f7ef342e4de24d6331a22ca4fc68c071.tar.xz
discord.c-1b311510f7ef342e4de24d6331a22ca4fc68c071.tar.zst
discord.c-1b311510f7ef342e4de24d6331a22ca4fc68c071.zip
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 9 insertions, 4 deletions
diff --git a/README.md b/README.md
index d429f27..063e4a5 100644
--- a/README.md
+++ b/README.md
@@ -5,10 +5,10 @@ an alternative client for the discord messaging platform, written in the C progr
## requirements
* a POSIX system
-* GNU C library
+* GNU C library
* GNU compiler collection
* GNU Make
-* libcurl 7.17.0 or newer with HTTPS support
+* libcurl 7.17.0 or newer with HTTPS support[\*](#user-content-notes)
* ncursesw6
* libcjson-dev
@@ -27,7 +27,7 @@ sudo apt install discord.c
you need to add [my apt repository](https://prog.sijanec.eu/).
-built packages only exist for the `amd64` and `arm64`. for i386 grab the source package:
+built packages only exist for `amd64`, `arm64` and `i386`. for other architectures grab the source package:
```
apt source discord.c
@@ -51,9 +51,14 @@ check the build badge before downloading:
* `amd64`: [https://cargova.sijanec.eu/prog/discord.c/](https://cargova.sijanec.eu/prog/discord.c/)
* `arm64`: [https://of.sijanec.eu/prog/discord.c/](https://of.sijanec.eu/prog/discord.c/)
+* `i386`: *built on my portable computer*
-there deb packages and binaries.
+there are deb packages and binaries.
## missing features
* check for permissions before join
+
+## notes
+
+\*`openssl` is [known](https://curl.se/mail/lib-2013-06/0007.html) to be `write()`ing to closed sockets and generating `SIGPIPE`s that `discord.c` does not catch and is terminated. Use a more sane TLS library instead such as `gnutls`, on which the `debian` package depends.