HACKING

   1 development dependencies
   2 ------------------------
   3
   4 * minitest RubyGem (version 4 or 5, standard in Ruby 2.0+)
   5 * curl - https://curl.haxx.se/ - we don't trust our own Ruby abilities :>
   6 * dd(1) - standard POSIX tool - to feed curl
   7 * ab - https://httpd.apache.org/ - for concurrent testing
   8 * GNU make - https://www.gnu.org/software/make/
   9 * git - https://www.git-scm.com/
  10 * ruby - https://www.ruby-lang.org/en/
  11
  12         git clone https://yhbt.net/yahns.git
  13
  14 tests
  15 -----
  16
  17 * make test - run each test in a separate process (parallelize using -j)
  18 * make test-mt - run tests-multithreaded in one process
  19 * make coverage - "make test" with coverage output
  20 * make coverage-mt - "make test-mt" with coverage output
  21 * ruby test/covshow.rb - show coverage output from previous test run
  22
  23 For non-GNU users, GNU make may be installed as "gmake".
  24
  25 test environment
  26 ----------------
  27
  28 N - specify the number of threads for *-mt targets (minitest parallelize_me!)
  29 RUBY - specify an alternative ruby(1) runtime
  30 V - set to 1 for verbose test output (may be mangled if multithreaded)
  31
  32 documentation
  33 -------------
  34
  35 We use pod2man(1) distributed with Perl 5 for generating manpages.
  36
  37 installing from git
  38 -------------------
  39
  40 * make install-gem
  41
  42 contact
  43 -------
  44
  45 We use git(7) and develop yahns using email like git.git hackers do.
  46 Please send patches via git-send-email(1) to us at <yahns-public@yhbt.net>.
  47 Pull requests should be formatted using git-request-pull(1).
  48
  49 All mail is archived publically at: https://yhbt.net/yahns-public/
  50 Anonymous contributions will always be welcome.
  51 No subscription is necessary to email us.
  52 Please remember to reply-to-all as we do not encourage subscription.
  53
  54 Copyright (C) 2013-2016 all contributors <yahns-public@yhbt.net>
  55 License: GPL-3.0+ <https://www.gnu.org/licenses/gpl-3.0.txt>