2
0
mirror of https://github.com/xvxx/phetch synced 2024-11-10 13:10:54 +00:00
phetch/README.md

82 lines
2.3 KiB
Markdown
Raw Normal View History

2019-12-18 00:56:28 +00:00
<p align="center">
2019-12-18 01:04:23 +00:00
<img src="./phetch.png">
<br> <br>
2019-12-18 01:12:03 +00:00
<a href="LICENSE">
<img src="https://img.shields.io/badge/license-MIT-blueviolet?style=flat-square">
</a>
<a href="https://github.com/dvkt/phetch/releases/tag/v0.0.0">
<img src="https://img.shields.io/badge/current_release-0.0.0-brightgreen.svg?style=flat-square">
</a>
<a href="https://github.com/dvkt/phetch">
<img src="https://img.shields.io/badge/dev_version-0.1.0--dev-lightgrey.svg?style=flat-square">
</a>
2019-12-18 00:56:28 +00:00
</p>
2019-12-18 00:48:30 +00:00
`phetch` is a terminal gopher client designed for quick keyboard navigation. It is the spiritual success to [GILD](https://github.com/dvkt/gild).
2019-11-22 07:45:02 +00:00
2019-11-24 20:29:01 +00:00
## features
2019-11-22 07:45:02 +00:00
2019-12-16 19:56:25 +00:00
- small (<1MB) executable for linux and macos
2019-11-23 04:01:19 +00:00
- technicolor design
2019-11-22 07:45:02 +00:00
- no nonsense keyboard navigation
2019-12-17 07:57:18 +00:00
## usage
phetch <gopher-url> # Show GopherHole at URL
phetch -raw <gopher-url> # Print raw Gopher response.
phetch -help # Show this screen.
phetch -version # Show phetch version.
2019-12-18 00:48:30 +00:00
## installation
MacOS:
wget https://github.com/dvkt/phetch/releases/download/v0.1.0/phetch-macos.zip
unzip phetch-macos.zip
./phetch -h
Linux x86_64:
wget https://github.com/dvkt/phetch/releases/download/v0.1.0/phetch-linux-x86-64.zip
unzip phetch-linux-x86-64.zip
./phetch -h
Linux ARM:
wget https://github.com/dvkt/phetch/releases/download/v0.1.0/phetch-linux-arm.zip
unzip phetch-linux-arm.zip
./phetch -h
2019-11-24 20:29:01 +00:00
## development
2019-11-22 07:45:02 +00:00
2019-12-17 20:23:07 +00:00
cargo run -- <gopher-url>
2019-11-24 20:29:01 +00:00
## resources
2019-12-16 19:34:40 +00:00
- [rfc 1346](https://tools.ietf.org/html/rfc1436)
2019-12-17 09:09:14 +00:00
- http://ascii-table.com/ansi-escape-sequences.php
2019-12-16 19:34:40 +00:00
2019-12-16 19:56:25 +00:00
## TODO
### Basics
2019-12-17 07:59:25 +00:00
- [ ] MENU: up/down scroll when next link out of view
- [ ] MENU: page up/page down show next page, highlight first link
2019-12-17 09:09:14 +00:00
- [ ] status() helper
- [ ] show errors in status()
- [ ] replace all panic! with errors
- [ ] replace all unwrap/expect with errors
- [ ] TLS
2019-12-17 07:59:25 +00:00
- [ ] MENU: open HTML link in browser
2019-12-16 19:56:25 +00:00
- [ ] `?` to show all keyboard shortcuts
2019-12-17 07:59:25 +00:00
- [ ] search functionality
2019-12-16 19:56:25 +00:00
- [ ] download to ~/Downloads
- [ ] save history to file
- [ ] load history from file
- [ ] load most recent URL when opening without args
### Bonus
2019-12-17 09:09:14 +00:00
- [ ] fuzzy find search links
- https://github.com/stewart/rff
- https://github.com/Schlechtwetterfront/fuzzy-rs
2019-12-17 20:23:07 +00:00
- [ ] detect SIGWINCH
- https://github.com/BurntSushi/chan-signal