README.gmi

   1 # htalkat: Haskell client and server for talkat (Talk Across TLS)
   2
   3 # Building from source
   4 Install the haskell package manager cabal, and the ncurses library and headers;
   5 e.g. on a debian system:
   6 ```
   7 $ sudo apt-get install cabal-install libncursesw5-dev
   8 ```
   9 Then in the htalkat directory, run:
  10 ```
  11 $ cabal update && cabal install
  12 ```
  13 The resulting binary will be installed by default as `~/.cabal/bin/htalkat`.
  14
  15 ## Compile-time options
  16 * `cabal install -f -curses`: compile without curses; a very simple dumb client is used instead.
  17
  18 # Basic usage
  19 ```
  20 # Create your cryptographic identity:
  21 htalkat i
  22 # Connect to a talkat URI:
  23 htalkat c talkat:1fb3034c92e2b5d32f78739995abf31b@example.invalid
  24 # Give it a short name:
  25 htalkat n talkat:1fb3034c92e2b5d32f78739995abf31b@example.invalid bob
  26 htalkat c bob
  27
  28 # Host your own talkat server; by default this will run on port 5518.
  29 htalkat l
  30 # Wait for someone to connect, then answer:
  31 htalkat a
  32
  33 # Get further help
  34 htalkat h
  35 ```
  36
  37 # Configuration
  38 After first run, you can edit ~/.htalkat/htalkat.conf for general configuration options, and ~/.htalkat/notify.sh to set how the server notifies you of incoming connections.
  39
  40 # Portability
  41 htalkat was written with POSIX systems in mind, and has only been tested on them, but it may also be possible to compile and run it on Windows. Please let me know if you try.
  42
  43 -- mbays@sdf.org