You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
phetch/README.md

66 lines
2.0 KiB
Markdown

4 years ago
<p align="center">
4 years ago
<img src="./img/logo.png">
4 years ago
</p>
4 years ago
4 years ago
`phetch` is a terminal client designed to help you quickly navigate the gophersphere.
5 years ago
4 years ago
## features
5 years ago
4 years ago
- <1MB executable for linux and mac
- technicolor design (based on [GILD](https://github.com/dvkt/gild))
5 years ago
- no nonsense keyboard navigation
- supports gopher searches, text and menu pages, and downloads
- save your favorite gopherholes with bookmarks
4 years ago
- opt-in history
5 years ago
4 years ago
## usage
4 years ago
phetch launch and show start page
phetch <gopher-url> open gopherhole at url
phetch -r, --raw <gopher-url> print raw gopher response
phetch -h, --help show this screen
phetch -v, --version show phetch version
4 years ago
4 years ago
Once you've launched phetch, use `ctrl-h` to view the on-line help.
4 years ago
## installation
4 years ago
Binaries for Linux, Mac, and Raspberry Pi are available at https://github.com/dvkt/phetch/releases:
4 years ago
- [phetch-v0.1.4-linux-x86_64.tar.gz](https://github.com/dvkt/phetch/releases/download/v0.1.4/phetch-v0.1.4-linux-x86_64.tar.gz)
- [phetch-v0.1.4-linux-armv7.tar.gz (RPi)](https://github.com/dvkt/phetch/releases/download/v0.1.4/phetch-v0.1.4-linux-armv7.tar.gz)
- [phetch-v0.1.4-macos.zip](https://github.com/dvkt/phetch/releases/download/v0.1.4/phetch-v0.1.4-macos.zip)
4 years ago
4 years ago
Just unzip/untar the `phetch` program into your $PATH and get going!
4 years ago
5 years ago
## development
5 years ago
cargo run -- <gopher-url>
4 years ago
## screenies
4 years ago
![DOS Archive](./img/dos.png)
4 years ago
![Menu View](./img/menu-view.png)
4 years ago
![Text View](./img/text-view.png)
4 years ago
## todo
4 years ago
4 years ago
- [ ] fork+exec telnet: gopher://bitreich.org/1/lawn/bbs
4 years ago
- [ ] alternate screen support
4 years ago
- [ ] bookmarks: toggle instead of just prepending to the file
- [ ] bookmarks: save the title of the current page
## bugs
4 years ago
- [ ] gopher://1436.ninja/1/twit.cgi ("iWritten and performed by Nathaniel" weirdness)
4 years ago
- [ ] screen flicker in win10 WSL
4 years ago
## future features
4 years ago
- [ ] Incremental search in Text views
- [ ] Linked gopher and http URLs in Text views
4 years ago
- [ ] TLS -- https://dataswamp.org/~solene/2019-03-07-gopher-server-tls.html
- [ ] Fuzzy Find incremental search