README.md

   1 [![Build Status](https://github.com/beanstalkd/beanstalkd/actions/workflows/build-latest.yaml/badge.svg)](https://github.com/beanstalkd/beanstalkd/actions/workflows/build-latest.yaml)
   2 [![codecov](https://codecov.io/gh/beanstalkd/beanstalkd/branch/master/graph/badge.svg)](https://codecov.io/gh/beanstalkd/beanstalkd)
   3
   4 # beanstalkd
   5
   6 Simple and fast general purpose work queue.
   7
   8 https://beanstalkd.github.io/
   9
  10 See [doc/protocol.txt](https://github.com/beanstalkd/beanstalkd/blob/master/doc/protocol.txt)
  11 for details of the network protocol.
  12
  13 Please note that this project is released with a Contributor
  14 Code of Conduct. By participating in this project you agree
  15 to abide by its terms. See CodeOfConduct.txt for details.
  16
  17 ## Quick Start
  18
  19     $ make
  20     $ ./beanstalkd
  21
  22
  23 also try,
  24
  25     $ ./beanstalkd -h
  26     $ ./beanstalkd -VVV
  27     $ make CFLAGS=-O2
  28     $ make CC=clang
  29     $ make check
  30     $ make install
  31     $ make install PREFIX=/usr
  32
  33 Requires Linux (2.6.17 or later), Mac OS X, FreeBSD, or Illumos.
  34
  35 Currently beanstalkd is tested with GCC and clang, but it should work
  36 with any compiler that supports C99.
  37
  38 Uses ronn to generate the manual.
  39 See http://github.com/rtomayko/ronn.
  40
  41
  42 ## Subdirectories
  43
  44 - `adm` - files useful for system administrators
  45 - `ct`  - testing tool; vendored from https://github.com/kr/ct
  46 - `doc` - documentation
  47 - `pkg` - scripts to make releases
  48
  49
  50 ## Tests
  51
  52 Unit tests are in test*.c. See https://github.com/kr/ct for
  53 information on how to write them.
  54