summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 13 insertions, 6 deletions
diff --git a/README.md b/README.md
index ac78ab5..975286d 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
# discord.c
-an alternative client for the discord messaging platform, written in the C programming language.
+an alternative client for a messaging platform, written in the C programming language.
code rewrite in 0.0.4 brings a lot of new features and marks the 0.0.3 release obsolete, though it still kind of works for terminal users, although it is very bad. rewritten version is better because it does not reach ratelimits due to using a socket connection and not polling for messages via HTTP. it also has voice support and a GUI frontend.
@@ -34,12 +34,11 @@ make
#### building requirements
-* a POSIX system - app is cross platform and should also be able to be compiled for all major OSes
+* a POSIX build system - app is cross platform and should also be able to be compiled for all major OSes
* `gcc`
* GNU `make`
-* `libwebsockets-dev` for faster bidirectional connections to the server
+* `libwebsockets-dev` for http and ws client and json parser
* `libgtk-3-dev` for the GUI
-* `libcjson-dev` for parsing server responses
* `libsoundio-dev` for crossplatform sound output
* `xxd` for embedding XML GtkBuilder UI definitions directly in the binary
@@ -62,11 +61,19 @@ discord.c is programmed in two separate sections, the ui section, that was previ
to your surprise, you can use the ui section, as of the code rewrite, as a library as well and integrate other platforms into it. No docs yet here either.
-The package for Debian comes with include header files and compiled shared objects so it can be used as a dependency, but beware, this dependency will depend on GTK+3.0, which would be, in case you are doing a GUI with a different widget toolkit, useless.
+~~The package for Debian comes with include header files and compiled shared objects so it can be used as a dependency, but beware, this dependency will depend on GTK+3.0, which would be, in case you are doing a GUI with a different widget toolkit, useless.~~
the program is, as of the code rewrite, single threaded, for increased stability and performance. it used to have separated network and ui threads, but now the threading model is abstracted with an event-based programming.
-## android port?
+## todo
+
+### discord.c interface for the blind
+
+a must-have feature is an alternative `ui.c` that would simply print messages to the console and be controllable fully from the keyboard, similar to the way pre-0.0.4 `discord.c` was created, but without `ncurses`. blind people can't interact with the messaging platform's official client at the time of writing, and I assume that users of `espeakup` and similar services mostly use their computer from the console and advanced GUI features are only a burden to them. I got an idea that if a piece of software is usable via the old-style printer terminals, only then it's usable for the blind.
+
+completing this task would make `discord.c` the first and the only alternative client with an easy to use interface for the blind.
+
+### android port
it would be useful to have an android port, and luckily this is possible with little effort due to the GTK broadway backend that interfaces with a HTML renderer, WebView for example.