/ README.md
README.md
1 # bollux - a bash Gemini client 2 3 inspired by 4 5 * [birch](https://github.com/dylanaraps/birch) 6 * [castor](https://git.sr.ht/~julienxx/castor) 7 * [gemini](https://gemini.circumlunar.space/) 8 9 # CAPABILITIES 10 11 * make requests 12 * receive files 13 * use `dd` to show a nice little download status 14 * use `less` to display text/* files 15 * link navigation 16 * man page 17 * configuration 18 * browse gopher 19 * history (basic) 20 21 # STILL TO DO 22 23 * history (advanced) 24 * test configuring capabilities 25 * bookmarks 26 * mailcap 27 * generate certificates 28 * implement TOFU 29 * handle http, etc links 30 31 # DEPENDENCIES 32 33 * bash >= 4.0 34 * iconv 35 * openssl 36 * less 37 * dd 38 39 # INSTALL 40 41 ## Packages 42 43 - [Slackware](https://slackbuilds.org/repository/14.2/network/bollux/) 44 45 ## From source 46 47 ``` 48 $ git clone https://git.sr.ht/~acdw/bollux 49 $ cd bollux 50 # make install 51 ``` 52 53 ## Alternative 54 55 ``` 56 $ curl -fLo bollux https://git.sr.ht/~acdw/bollux/blob/0.3.0/bollux 57 $ chmod +x bollux 58 $ ./bollux 59 ``` 60 61 It's a bash script, so just plop it in your $PATH somewhere. 62 63 # LICENSE 64 65 MIT 66 67 # CONTRIBUTING 68 69 Feel free to write to my 70 [public inbox](https://lists.sr.ht/~acdw/public-inbox) 71 with changes you'd like to make, or submit an issue to the 72 [ticket tracker.](https://todo.sr.ht/~acdw/bollux)