commit 5c2276b3bdf0be77fa6dddc2f34a67c8ec3bca4b

Author: Julien Blanchard <julien@sideburns.eu>

Date: Tue Dec 24 14:50:20 2019 +0100

Add README

diff --git a/README.md b/README.md

new file mode 100644

index 0000000..2f031ac

--- /dev/null

+++ b/README.md

@@ -0,0 +1,29 @@

+# Castor

+

+`castor` is a graphical Gemini Project client written in Rust with GTK.

+

+

+## Installation

+

+Grab a release or build castor and install it manually.

+

+- clone the repository

+

+- install openssl, gtk and pango development headers

+

+- run `cargo build --release`

+

+- copy the release somewhere and make it executable.

+

+- Visit gemini://gemini.circumlunar.space

+

+

+## TODO

+

+- [x] Open links in external apps

+- [x] Support input type

+- [x] Bookmarking

+- [ ] Support theming

+- [ ] Add/make an icon

+- [ ] Pass Conman's torture redirections tests

+- [ ] Build executables for multiple platforms

---

Served by Pollux Gemini Server.