+TITLE: NcGopher README

ncgopher

=ncgopher= is a gopher client for the modern internet. It uses ncurses and is written in Rust.

The software is still in alpha, and it is also my first application written in Rust. Expect lots of bugs and badly written Rust code.

** gopher

Gopher was developed in 1991 at the University of Minnesota, and named after the school's mascot. Gopher is a menu-driven interface that allows a user to browse for text information served off of various gopher servers.

** Screenshot

Obligatory screenshot:

+CAPTION: Screenshot of NcGopher

+NAME: screenshot1

[[./screenshots/ncgopher.png]]

** Features

Ncurses interface
Keyboard command for navigation
Bookmarks support including custom title
History of visited gopher holes
Download of text files and gophermaps (Save as...)
Download of binary files
Menu for easy configuration
Mouse support in some terminals
TLS support

** Installation

=ncgopher= has no fancy installation process right now. Clone the repository, =cd= to the =ncgopher= directory and run

#+BEGIN_EXAMPLE
cargo build
cargo run
#+END_EXAMPLE

** Key bindings

During alpha, the keybindings are not configurable and many operations are still not implemented.

|------------+--------------------------------| | Key | Command | |------------+--------------------------------| | Arrow keys | Move around in text | | Enter | Open the link under the cursor | | Esc | Go to menubar | | g | Open new URL | | b | Navigate back | | q | Close application | | s | Save current page | | r | Reload current page | | i | Show link under cursor | | a | Add bookmark for current page | |------------+--------------------------------|

** Debugging

If the application crashes, I'd be interested in a backtrace. Start the application with ~RUST_BACKTRACE=1 cargo run~. There is also a debug view that can be activated with the =~=-key.

** License

=ncgopher= is licensed under the BSD 2-clause license.