bollux/README.md

60 lines
1.1 KiB
Markdown
Raw Normal View History

2020-05-22 22:19:00 +00:00
# bollux - a bash Gemini client
2020-05-22 13:38:40 +00:00
inspired by
2020-06-01 20:08:53 +00:00
* [birch](https://github.com/dylanaraps/birch)
* [castor](https://git.sr.ht/~julienxx/castor)
* [gemini](https://gemini.circumlunar.space/)
2020-05-22 22:19:00 +00:00
# CAPABILITIES
* make requests
* receive files
* use `dd` to show a nice little download status
2020-05-24 05:28:01 +00:00
* use `less` to display text/* files
2020-05-26 02:48:36 +00:00
* link navigation
2020-05-30 21:46:04 +00:00
* man page
* configuration
2020-05-22 22:19:00 +00:00
# STILL TO DO
2020-06-01 20:08:53 +00:00
* history --
SEE the [history branch](https://git.sr.ht/~acdw/bollux/tree/history)
2020-05-30 21:46:04 +00:00
* test configuring capabilities
* bookmarks
2020-05-24 05:28:01 +00:00
* mailcap something
2020-05-22 22:19:00 +00:00
* generate certificates?
* implement TOFU?
2020-05-26 02:48:36 +00:00
* recognize more protocols
2020-06-01 20:13:31 +00:00
# INSTALL
## From source
```
$ git clone https://git.sr.ht/~acdw/bollux
$ cd bollux
# make install
```
## Alternative
```
$ curl -fLo bollux https://git.sr.ht/~acdw/bollux/blob/0.2.2/bollux
$ chmod +x bollux
$ ./bollux
```
It's a bash script, so just plop it in your $PATH somewhere.
2020-05-26 02:48:36 +00:00
# LICENSE
MIT
# CONTRIBUTING
Feel free to write to my
2020-06-01 20:08:53 +00:00
[public inbox](https://lists.sr.ht/~acdw/public-inbox)
2020-05-26 02:48:36 +00:00
with changes you'd like to make, or submit an issue to the
2020-06-01 20:08:53 +00:00
[ticket tracker.](https://todo.sr.ht/~acdw/bollux)