mention media in README

pull/22/head
chris west 4 years ago
parent 65c8403e0e
commit 67021ea036

@ -36,6 +36,8 @@ the gophersphere.
## usage ## usage
Usage:
phetch [options] Launch phetch in interactive mode phetch [options] Launch phetch in interactive mode
phetch [options] url Open Gopher URL in interactive mode phetch [options] url Open Gopher URL in interactive mode
@ -100,9 +102,9 @@ Regular development uses `cargo`:
cargo run -- <gopher-url> cargo run -- <gopher-url>
_Pro-tip:_ Run a local gopher server (like [phd][phd]) on _Pro-tip:_ Run a local gopher server (like [phd]) on `0.0.0.0:7070`
`127.0.0.1:7070` and start phetch with `-l` or `--local` to quickly and start phetch with `-l` or `--local` to quickly connect to it.
connect to it. Useful for debugging! Useful for debugging!
phetch builds with TLS and Tor support by default. To disable these phetch builds with TLS and Tor support by default. To disable these
features, or to enable only one of them, use the features, or to enable only one of them, use the
@ -118,13 +120,23 @@ To enable just TLS support, or just Tor support, use `--features`:
cargo run --no-default-features --features tor -- gopher://phetch/about cargo run --no-default-features --features tor -- gopher://phetch/about
## media player support
phetch includes experimental support for opening video files (`;` item
type) and sound files (`s` item type) in [mpv]. To test it out,
compile phetch using the `--features media` flag and then visit a
compatible Gopher server (maybe one using [gophor]?). Or check out the
"gopher types" help page by pressing `ctrl-h` then `3` in phetch:
$ cargo run --features media gopher://phetch/1/help/types
## todo ## todo
- [ ] ctrl-c in load() not yet implemented - [ ] ctrl-c in load() not yet implemented
## bugs ## bugs
- [ ] ctrl-c while telneting kills phetch - [ ] telnet IO seems broken after raw_input change (1146f42)
## future features ## future features
@ -141,3 +153,5 @@ To enable just TLS support, or just Tor support, use `--features`:
[2]: https://github.com/xvxx/phetch/releases/download/v1.0.2/phetch-v1.0.2-macos.zip [2]: https://github.com/xvxx/phetch/releases/download/v1.0.2/phetch-v1.0.2-macos.zip
[phd]: https://github.com/xvxx/phd [phd]: https://github.com/xvxx/phd
[aur]: https://wiki.archlinux.org/index.php/AUR_helpers [aur]: https://wiki.archlinux.org/index.php/AUR_helpers
[mpv]: https://github.com/mpv-player/mpv
[gophor]: https://github.com/grufwub/gophor

@ -294,7 +294,7 @@ gGIFs /help/types phetch
Iimages downloads /help/types phetch Iimages downloads /help/types phetch
ddocuments /help/types phetch ddocuments /help/types phetch
i i
iand opening these in a media player: iand these media types:
i i
ssound files URL:https://freepd.com/music/Wakka%20Wakka.mp3 phetch ssound files URL:https://freepd.com/music/Wakka%20Wakka.mp3 phetch
;video files URL:https://www.youtube.com/watch?v=oHg5SJYRHA0 phetch ;video files URL:https://www.youtube.com/watch?v=oHg5SJYRHA0 phetch

Loading…
Cancel
Save