commit 8918a1a43cdced11ac562f787be3b8ea9ab20a66

Author: Julien Blanchard <julien@sideburns.eu>

Date: Sat Jan 11 17:34:27 2020 +0100

Update README

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

index e44cb59..1d763e6 100644

--- a/README.md

+++ b/README.md

@@ -1,29 +1,48 @@

Castor

-A graphical client for plain-text protocols written in Rust with GTK.

+A graphical client for plain-text protocols written in Rust with GTK.

It currently supports the Gemini, Gopher and Finger protocols.

-

+

Installation

-Grab a release or build castor and install it manually. You will need a recent Rust

-version >= 1.39. Please consider using [Rustup](https://rustup.rs) if you OS does

-not package a recent version.

+Castor needs a recent Rust version >= 1.39. Please consider using [Rustup](https://rustup.rs)

+if you OS does not package a recent version.

-- clone the repository

-- install openssl, gtk+3, gdk-pixbuf, pango, atk, cairo development libraries.

-- run `cargo build --release`

-- copy the release somewhere and make it executable.

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

+### Dependencies

+

+You will need some development libraries:

+

+- openssl

+- gtk+3

+- gdk-pixbuf

+- pango

+- atk

+- cairo

+

+### Build and install

+

+- run `make` to build Castor

+- install with `sudo make install`

+- Open Castor and visit gemini://gemini.circumlunar.space and enjoy your trip!

Mailing list

-If you have questions, feature requests, bugs or you just want to keep up to date with Castor you can send a message to the [mailing list](https://lists.sr.ht/~julienxx/castor)

+If you have questions, feature requests, bugs or you just want to keep up to date with Castor you

+can send a message to the [mailing list](https://lists.sr.ht/~julienxx/castor)

Roadmap

You can view my current roadmap [here](https://todo.sr.ht/~julienxx/Castor)

+

+

+## Thanks

+

+- Leonora Tindall for the [great article](https://nora.codes/tutorial/speedy-desktop-apps-with-gtk-and-rust/) on Rust and GTK that helped me bootstrap this project

+- tiwesdaeg for the incredible icon

+- sloum for the great advices

+- the gemini/gopher/finger community for being awesome

---

Served by Pollux Gemini Server.