README.md

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