README.md

   1 # bollux - a bash Gemini client
   2
   3 [![Shellcheck Status](https://drone.tildegit.org/api/badges/acdw/bollux/status.svg)](https://drone.tildegit.org/acdw/bollux)
   4
   5 inspired by
   6
   7 * [birch](https://github.com/dylanaraps/birch)
   8 * [castor](https://git.sr.ht/~julienxx/castor)
   9 * [gemini](https://gemini.circumlunar.space/)
  10
  11 # CAPABILITIES
  12
  13 * make requests
  14 * receive files
  15 * use `dd` to show a nice little download status
  16 * use `less` to display text/* files
  17 * link navigation
  18 * man page
  19 * configuration
  20 * browse gopher
  21 * history (basic)
  22
  23 # STILL TO DO
  24
  25 * history (advanced)
  26 * test configuring capabilities
  27 * bookmarks
  28 * mailcap
  29 * generate certificates
  30 * implement TOFU
  31 * handle http, etc links
  32
  33 # DEPENDENCIES
  34
  35 * bash >= 4.0
  36 * iconv
  37 * openssl
  38 * less (with lesskey)
  39 * dd
  40
  41 # INSTALL
  42
  43 ## Packages
  44
  45 - [Slackware](https://slackbuilds.org/repository/14.2/network/bollux/)
  46
  47 ## From source
  48
  49 ```
  50 $ git clone https://git.sr.ht/~acdw/bollux
  51 $ cd bollux
  52 # make install
  53 ```
  54
  55 **NOTE** if you installed an older version, make sure to rm /usr/bin/bollux.
  56 The new install path is /usr/local/bin.
  57
  58 ## Alternative
  59
  60 ```
  61 $ curl -fLo bollux https://tildegit.org/bollux/raw/branch/main/bollux
  62 $ chmod +x bollux
  63 $ ./bollux
  64 ```
  65
  66 It's a bash script, so just plop it in your $PATH somewhere.
  67
  68 # LICENSE
  69
  70 MIT
  71
  72 # CONTRIBUTING
  73
  74 Create an [issue](https://tildegit.org/acdw/bollux/issues/new) or
  75 [pull request](https://tildegit.org/acdw/bollux/compare/main...main) and I'll
  76 get back to you posthaste!