granicus.if.org Git - libevent/blob - README.md

   1 <p align="center">
   2   <img src="https://libevent.org/libevent3.png" alt="libevent logo"/>
   3 </p>
   4
   5
   6
   7 [![CI](https://github.com/libevent/libevent/actions/workflows/build.yml/badge.svg)](https://github.com/libevent/libevent/actions/workflows/build.yml)
   8 [![Coverage Status](https://coveralls.io/repos/github/libevent/libevent/badge.svg)](https://coveralls.io/github/libevent/libevent)
   9 [![Join the chat at https://gitter.im/libevent/libevent](https://badges.gitter.im/libevent/libevent.svg)](https://gitter.im/libevent/libevent?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
  10 [![doxygen](https://img.shields.io/badge/doxygen-documentation-blue.svg)](https://libevent.org/doc)
  11
  12
  13
  14 # 1. BUILDING AND INSTALLATION
  15
  16 ## Autoconf
  17
  18 ```
  19 $ ./configure
  20 $ make
  21 $ make verify   # (optional)
  22 $ sudo make install
  23 ```
  24
  25 See [Documentation/Building#Autoconf](/Documentation/Building.md#autoconf) for more information
  26
  27 ## CMake (Windows)
  28
  29 Install CMake: <https://www.cmake.org>
  30
  31 ```
  32 $ md build && cd build
  33 $ cmake -G "Visual Studio 10" ..   # Or use any generator you want to use. Run cmake --help for a list
  34 $ cmake --build . --config Release # Or "start libevent.sln" and build with menu in Visual Studio.
  35 ```
  36
  37 See [Documentation/Building#Building on Windows](/Documentation/Building.md#building-on-windows) for more information
  38
  39 ## CMake (Unix)
  40
  41 ```
  42 $ mkdir build && cd build
  43 $ cmake ..     # Default to Unix Makefiles.
  44 $ make
  45 $ make verify  # (optional)
  46 ```
  47
  48 See [Documentation/Building#Building on Unix (With CMake)](/Documentation/Building.md#building-on-unix-cmake) for more information
  49
  50 ## Package Managers
  51
  52 You can download and install libevent using the [vcpkg](https://github.com/Microsoft/vcpkg) dependency manager:
  53
  54     git clone https://github.com/Microsoft/vcpkg.git
  55     cd vcpkg
  56     ./bootstrap-vcpkg.sh
  57     ./vcpkg integrate install
  58     ./vcpkg install libevent
  59
  60 The libevent port in vcpkg is kept up to date by Microsoft team members and community contributors. If the version is out of date, please [create an issue or pull request](https://github.com/Microsoft/vcpkg) on the vcpkg repository.
  61
  62 # 2. USEFUL LINKS:
  63
  64 For the latest released version of Libevent, see the official website at
  65 <http://libevent.org/> .
  66
  67 There's a pretty good work-in-progress manual up at
  68    <http://www.wangafu.net/~nickm/libevent-book/> .
  69
  70 For the latest development versions of Libevent, access our Git repository
  71 via
  72
  73 ```
  74 $ git clone https://github.com/libevent/libevent.git
  75 ```
  76
  77 You can browse the git repository online at:
  78
  79 <https://github.com/libevent/libevent>
  80
  81 To report bugs, issues, or ask for new features:
  82
  83 __Patches__: https://github.com/libevent/libevent/pulls
  84 > OK, those are not really _patches_. You fork, modify, and hit the "Create Pull Request" button.
  85 > You can still submit normal git patches via the mailing list.
  86
  87 __Bugs, Features [RFC], and Issues__: https://github.com/libevent/libevent/issues
  88 > Or you can do it via the mailing list.
  89
  90 There's also a libevent-users mailing list for talking about Libevent
  91 use and development:
  92
  93 <http://archives.seul.org/libevent/users/>
  94
  95 # 3. ACKNOWLEDGMENTS
  96
  97 The [following people](/CONTRIBUTORS.md) have helped with suggestions, ideas,
  98 code or fixing bugs.