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

73 lines
2.2 KiB
Markdown
Raw Normal View History

2019-12-18 00:56:28 +00:00
<p align="center">
2019-12-19 17:27:48 +00:00
<img src="./img/logo.png">
2019-12-18 01:04:23 +00:00
<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 01:13:02 +00:00
</p>
2019-12-18 00:48:30 +00:00
2019-12-23 07:35:44 +00:00
`phetch` is a terminal client designed to quickly navigate the gophersphere.
2019-11-22 07:45:02 +00:00
2019-12-19 04:52:21 +00:00
**features:**
2019-11-22 07:45:02 +00:00
2019-12-20 04:29:10 +00:00
- <1MB executable for linux and mac
- technicolor design (based on [GILD](https://github.com/dvkt/gild))
2019-11-22 07:45:02 +00:00
- no nonsense keyboard navigation
2019-12-17 07:57:18 +00:00
## usage
2019-12-20 03:54:08 +00:00
phetch # Launch and show start page.
2019-12-20 04:29:10 +00:00
phetch <gopher-url> # Launch and show Gopherhole at URL.
2019-12-18 01:46:12 +00:00
phetch -r <gopher-url> # Print raw Gopher response.
2019-12-20 04:29:10 +00:00
phetch -h # Show help.
phetch -v # Show version.
2019-12-17 07:57:18 +00:00
2019-12-18 00:48:30 +00:00
## installation
2019-12-19 05:44:58 +00:00
Binaries for Linux and Mac are available at https://github.com/dvkt/phetch/releases:
2019-12-18 00:48:30 +00:00
2019-12-19 05:44:58 +00:00
- MacOS: https://github.com/dvkt/phetch/releases/download/v0.1.0/phetch-macos.zip
- Linux x86_64: https://github.com/dvkt/phetch/releases/download/v0.1.0/phetch-linux-x86-64.tar.gz
- Linux ARM: https://github.com/dvkt/phetch/releases/download/v0.1.0/phetch-linux-arm.tar.gz
2019-12-19 04:52:21 +00:00
2019-12-19 05:44:58 +00:00
Just unzip/untar the `phetch` program into your $PATH and get going!
2019-12-18 00:48:30 +00:00
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-12-20 04:34:03 +00:00
## screenies
![Links](./img/links.png)
![DOS Menu](./img/menu.png)
![Game Archive](./img/oldies.png)
2019-12-19 05:56:37 +00:00
## todo
2019-12-16 19:56:25 +00:00
2019-12-23 08:46:03 +00:00
- [ ] bookmarks help file
- [ ] bookmarks no ~/.config/phetch/ error
- [ ] history help file
- [ ] history no ~/.config/phetch/ error
2019-12-20 04:29:10 +00:00
- [ ] new screenshots
2019-12-20 18:22:35 +00:00
- [ ] little GIF screencast in README
2019-12-22 22:57:43 +00:00
- [ ] telnet: gopher://bitreich.org/1/lawn/bbs
2019-12-18 21:40:09 +00:00
2019-12-20 04:34:03 +00:00
## bugs
2019-12-18 21:40:09 +00:00
2019-12-21 00:03:34 +00:00
- [ ] gopher://1436.ninja/1/twit.cgi ("iWritten and performed by Nathaniel" weirdness)
2019-12-20 18:22:35 +00:00
## future features
2019-12-23 07:34:53 +00:00
- [ ] Incremental search in Text views
- [ ] Linked gopher and http links in Text views
- [ ] TLS -- https://dataswamp.org/~solene/2019-03-07-gopher-server-tls.html
- [ ] Fuzzy Find incremental search