Add README.md

2024-11-23 04:51:59 +01:00 · 2020-09-20 14:49:57 -04:00 · 2020-09-20 14:49:57 -04:00 · a3d5169d71
commit a3d5169d71
parent b136eea98a
1 changed files with 22 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -0,0 +1,22 @@
+# gmni - A Gemini client
+
+This is a [Gemini](https://gemini.circumlunar.space/) client.
+
+Dependencies:
+
+- A POSIX-like system and a C11 compiler
+- OpenSSL
+- [scdoc](https://sr.ht/~sircmpwn/scdoc/) (optional)
+
+## Compiling
+
+```
+$ mkdir build && cd build
+$ ../configure
+$ make
+# make install
+```
+
+## Usage
+
+See `gmni(1)` for the CLI usage.