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
  19 # STILL TO DO
  20
  21 * history --
  22   SEE the [history branch](https://git.sr.ht/~acdw/bollux/tree/history)
  23 * test configuring capabilities
  24 * bookmarks
  25 * mailcap something
  26 * generate certificates?
  27 * implement TOFU?
  28 * recognize more protocols
  29
  30 # DEPENDENCIES
  31
  32 * bash >= 4.0
  33 * iconv
  34 * openssl
  35 * gawk
  36 * less
  37 * dd
  38
  39 # INSTALL
  40
  41 ## From source
  42
  43 ```
  44 $ git clone https://git.sr.ht/~acdw/bollux
  45 $ cd bollux
  46 # make install
  47 ```
  48
  49 ## Alternative
  50
  51 ```
  52 $ curl -fLo bollux https://git.sr.ht/~acdw/bollux/blob/0.3.0/bollux
  53 $ chmod +x bollux
  54 $ ./bollux
  55 ```
  56
  57 It's a bash script, so just plop it in your $PATH somewhere.
  58
  59 # LICENSE
  60
  61 MIT
  62
  63 # CONTRIBUTING
  64
  65 Feel free to write to my
  66 [public inbox](https://lists.sr.ht/~acdw/public-inbox)
  67 with changes you'd like to make, or submit an issue to the
  68 [ticket tracker.](https://todo.sr.ht/~acdw/bollux)