mirror of
https://github.com/cuberite/libevent.git
synced 2025-09-11 13:24:43 -04:00
Clean up the README some.
This commit is contained in:
JoakimSoderberg
parent
604b8cc4d1
commit
8d4cb35dda
379
README.md
379
README.md
@ -2,31 +2,27 @@
|
|||||||
|
|
||||||
## Autoconf
|
## Autoconf
|
||||||
|
|
||||||
```
|
$ ./configure
|
||||||
$ ./configure
|
$ make
|
||||||
$ make
|
$ make verify # (optional)
|
||||||
$ make verify # (optional)
|
$ sudo make install
|
||||||
$ sudo make install
|
|
||||||
```
|
|
||||||
|
|
||||||
## CMake (Windows)
|
## CMake (Windows)
|
||||||
|
|
||||||
<http://www.cmake.org>
|
Install CMake: <http://www.cmake.org>
|
||||||
|
|
||||||
```
|
|
||||||
$ md build && cd build
|
$ md build && cd build
|
||||||
$ cmake -G "Visual Studio 10" .. # Or whatever generator you want to use cmake --help for a list.
|
$ cmake -G "Visual Studio 10" .. # Or whatever generator you want to use cmake --help for a list.
|
||||||
$ start libevent.sln
|
$ start libevent.sln
|
||||||
```
|
|
||||||
|
|
||||||
## CMake (Unix)
|
## CMake (Unix)
|
||||||
|
|
||||||
```
|
$ mkdir build && cd build
|
||||||
$ mkdir build && cd build
|
$ cmake .. # Default to Unix Makefiles.
|
||||||
$ cmake .. # Default to Unix Makefiles.
|
$ make
|
||||||
$ make
|
$ make verify # (optional)
|
||||||
$ make verify # (optional)
|
|
||||||
```
|
|
||||||
|
|
||||||
# 1. BUILDING AND INSTALLATION (In Depth)
|
# 1. BUILDING AND INSTALLATION (In Depth)
|
||||||
|
|
||||||
@ -34,29 +30,26 @@ $ make verify # (optional)
|
|||||||
|
|
||||||
To build libevent, type
|
To build libevent, type
|
||||||
|
|
||||||
$ ./configure && make
|
$ ./configure && make
|
||||||
|
|
||||||
(If you got libevent from the git repository, you will
|
|
||||||
first need to run the included "autogen.sh" script in order to
|
(If you got libevent from the git repository, you will
|
||||||
generate the configure script.)
|
first need to run the included "autogen.sh" script in order to
|
||||||
|
generate the configure script.)
|
||||||
|
|
||||||
You can run the regression tests by running
|
You can run the regression tests by running
|
||||||
|
|
||||||
```
|
$ make verify
|
||||||
$ make verify
|
|
||||||
```
|
|
||||||
|
|
||||||
Install as root via
|
Install as root via
|
||||||
|
|
||||||
```
|
$ make install
|
||||||
$ make install
|
|
||||||
```
|
|
||||||
|
|
||||||
Before reporting any problems, please run the regression tests.
|
Before reporting any problems, please run the regression tests.
|
||||||
|
|
||||||
To enable the low-level tracing build the library as:
|
To enable the low-level tracing build the library as:
|
||||||
|
|
||||||
CFLAGS=-DUSE_DEBUG ./configure [...]
|
$ CFLAGS=-DUSE_DEBUG ./configure [...]
|
||||||
|
|
||||||
Standard configure flags should work. In particular, see:
|
Standard configure flags should work. In particular, see:
|
||||||
|
|
||||||
@ -81,13 +74,19 @@ To build libevent using Microsoft Visual studio open the "Visual Studio Command
|
|||||||
|
|
||||||
```
|
```
|
||||||
$ cd <libevent source dir>
|
$ cd <libevent source dir>
|
||||||
|
$ mkdir build && cd build
|
||||||
$ cmake -G "Visual Studio 10" .. # Or whatever generator you want to use cmake --help for a list.
|
$ cmake -G "Visual Studio 10" .. # Or whatever generator you want to use cmake --help for a list.
|
||||||
$ start libevent.sln
|
$ start libevent.sln
|
||||||
```
|
```
|
||||||
|
|
||||||
Then build the entire solution via the Build menu.
|
In the above, the ".." refers to the dir containing the Libevent source code.
|
||||||
|
You can build multiple versions (with different compile time settings) from the same source tree
|
||||||
|
by creating other build directories.
|
||||||
|
|
||||||
the "NMake Makefiles" CMake generator can be used to build entirely via the command line.
|
It is highly recommended to build "out of source" when using
|
||||||
|
CMake instead of "in source" like the normal behaviour of autoconf for this reason.
|
||||||
|
|
||||||
|
The "NMake Makefiles" CMake generator can be used to build entirely via the command line.
|
||||||
|
|
||||||
To get a list of settings available for the project you can type:
|
To get a list of settings available for the project you can type:
|
||||||
|
|
||||||
@ -95,8 +94,10 @@ To get a list of settings available for the project you can type:
|
|||||||
$ cmake -LH ..
|
$ cmake -LH ..
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### GUI
|
||||||
|
|
||||||
CMake also provides a GUI that lets you specify the source directory and output (binary) directory
|
CMake also provides a GUI that lets you specify the source directory and output (binary) directory
|
||||||
that the build should be placed in.
|
that the build should be placed in.
|
||||||
|
|
||||||
### OpenSSL support
|
### OpenSSL support
|
||||||
|
|
||||||
@ -106,7 +107,7 @@ these can be found here: <http://www.openssl.org/related/binaries.html>
|
|||||||
# 2. USEFUL LINKS:
|
# 2. USEFUL LINKS:
|
||||||
|
|
||||||
For the latest released version of Libevent, see the official website at
|
For the latest released version of Libevent, see the official website at
|
||||||
http://libevent.org/ .
|
<http://libevent.org/> .
|
||||||
|
|
||||||
There's a pretty good work-in-progress manual up at
|
There's a pretty good work-in-progress manual up at
|
||||||
<http://www.wangafu.net/~nickm/libevent-book/> .
|
<http://www.wangafu.net/~nickm/libevent-book/> .
|
||||||
@ -119,170 +120,176 @@ $ git clone git://levent.git.sourceforge.net/gitroot/levent/libevent
|
|||||||
```
|
```
|
||||||
|
|
||||||
You can browse the git repository online at:
|
You can browse the git repository online at:
|
||||||
<http://levent.git.sourceforge.net/git/gitweb-index.cgi> .
|
|
||||||
|
<http://levent.git.sourceforge.net/git/gitweb-index.cgi>
|
||||||
|
|
||||||
<https://github.com/libevent/Libevent>
|
<https://github.com/libevent/Libevent>
|
||||||
|
|
||||||
To report bugs, request features, or submit patches to Libevent,
|
To report bugs, request features, or submit patches to Libevent,
|
||||||
use the Sourceforge trackers at
|
use the Sourceforge trackers at
|
||||||
https://sourceforge.net/tracker/?group_id=50884 .
|
|
||||||
|
<https://sourceforge.net/tracker/?group_id=50884>
|
||||||
|
|
||||||
There's also a libevent-users mailing list for talking about Libevent
|
There's also a libevent-users mailing list for talking about Libevent
|
||||||
use and development: http://archives.seul.org/libevent/users/
|
use and development:
|
||||||
|
|
||||||
|
<http://archives.seul.org/libevent/users/>
|
||||||
|
|
||||||
# 3. ACKNOWLEDGMENTS
|
# 3. ACKNOWLEDGMENTS
|
||||||
|
|
||||||
The following people have helped with suggestions, ideas, code or
|
The following people have helped with suggestions, ideas, code or
|
||||||
fixing bugs:
|
fixing bugs:
|
||||||
|
|
||||||
Samy Al Bahra
|
* Samy Al Bahra
|
||||||
Jacob Appelbaum
|
* Jacob Appelbaum
|
||||||
Arno Bakker
|
* Arno Bakker
|
||||||
Weston Andros Adamson
|
* Weston Andros Adamson
|
||||||
William Ahern
|
* William Ahern
|
||||||
Ivan Andropov
|
* Ivan Andropov
|
||||||
Sergey Avseyev
|
* Sergey Avseyev
|
||||||
Avi Bab
|
* Avi Bab
|
||||||
Joachim Bauch
|
* Joachim Bauch
|
||||||
Gilad Benjamini
|
* Gilad Benjamini
|
||||||
Stas Bekman
|
* Stas Bekman
|
||||||
Denis Bilenko
|
* Denis Bilenko
|
||||||
Julien Blache
|
* Julien Blache
|
||||||
Kevin Bowling
|
* Kevin Bowling
|
||||||
Tomash Brechko
|
* Tomash Brechko
|
||||||
Kelly Brock
|
* Kelly Brock
|
||||||
Ralph Castain
|
* Ralph Castain
|
||||||
Adrian Chadd
|
* Adrian Chadd
|
||||||
Lawnstein Chan
|
* Lawnstein Chan
|
||||||
Shuo Chen
|
* Shuo Chen
|
||||||
Ka-Hing Cheung
|
* Ka-Hing Cheung
|
||||||
Andrew Cox
|
* Andrew Cox
|
||||||
Paul Croome
|
* Paul Croome
|
||||||
George Danchev
|
* George Danchev
|
||||||
Andrew Danforth
|
* Andrew Danforth
|
||||||
Ed Day
|
* Ed Day
|
||||||
Christopher Davis
|
* Christopher Davis
|
||||||
Mike Davis
|
* Mike Davis
|
||||||
Antony Dovgal
|
* Antony Dovgal
|
||||||
Mihai Draghicioiu
|
* Mihai Draghicioiu
|
||||||
Alexander Drozdov
|
* Alexander Drozdov
|
||||||
Mark Ellzey
|
* Mark Ellzey
|
||||||
Shie Erlich
|
* Shie Erlich
|
||||||
Leonid Evdokimov
|
* Leonid Evdokimov
|
||||||
Juan Pablo Fernandez
|
* Juan Pablo Fernandez
|
||||||
Christophe Fillot
|
* Christophe Fillot
|
||||||
Mike Frysinger
|
* Mike Frysinger
|
||||||
Remi Gacogne
|
* Remi Gacogne
|
||||||
Artem Germanov
|
* Artem Germanov
|
||||||
Alexander von Gernler
|
* Alexander von Gernler
|
||||||
Artur Grabowski
|
* Artur Grabowski
|
||||||
Diwaker Gupta
|
* Diwaker Gupta
|
||||||
Sebastian Hahn
|
* Sebastian Hahn
|
||||||
Dave Hart
|
* Dave Hart
|
||||||
Greg Hazel
|
* Greg Hazel
|
||||||
Nicholas Heath
|
* Nicholas Heath
|
||||||
Michael Herf
|
* Michael Herf
|
||||||
Sebastian Hahn
|
* Sebastian Hahn
|
||||||
Savg He
|
* Savg He
|
||||||
Mark Heily
|
* Mark Heily
|
||||||
Maxime Henrion
|
* Maxime Henrion
|
||||||
Michael Herf
|
* Michael Herf
|
||||||
Greg Hewgill
|
* Greg Hewgill
|
||||||
Andrew Hochhaus
|
* Andrew Hochhaus
|
||||||
Aaron Hopkins
|
* Aaron Hopkins
|
||||||
Tani Hosokawa
|
* Tani Hosokawa
|
||||||
Jamie Iles
|
* Jamie Iles
|
||||||
Xiuqiang Jiang
|
* Xiuqiang Jiang
|
||||||
Claudio Jeker
|
* Claudio Jeker
|
||||||
Evan Jones
|
* Evan Jones
|
||||||
George Kadianakis
|
* George Kadianakis
|
||||||
Phua Keat
|
* Phua Keat
|
||||||
Azat Khuzhin
|
* Azat Khuzhin
|
||||||
Alexander Klauer
|
* Alexander Klauer
|
||||||
Kevin Ko
|
* Kevin Ko
|
||||||
Brian Koehmstedt
|
* Brian Koehmstedt
|
||||||
Marko Kreen
|
* Marko Kreen
|
||||||
Valery Kyholodov
|
* Valery Kyholodov
|
||||||
Ross Lagerwall
|
* Ross Lagerwall
|
||||||
Scott Lamb
|
* Scott Lamb
|
||||||
Christopher Layne
|
* Christopher Layne
|
||||||
Adam Langley
|
* Adam Langley
|
||||||
Graham Leggett
|
* Graham Leggett
|
||||||
Volker Lendecke
|
* Volker Lendecke
|
||||||
Philip Lewis
|
* Philip Lewis
|
||||||
Zhou Li
|
* Zhou Li
|
||||||
David Libenzi
|
* David Libenzi
|
||||||
Yan Lin
|
* Yan Lin
|
||||||
Moshe Litvin
|
* Moshe Litvin
|
||||||
Simon Liu
|
* Simon Liu
|
||||||
Mitchell Livingston
|
* Mitchell Livingston
|
||||||
Hagne Mahre
|
* Hagne Mahre
|
||||||
Lubomir Marinov
|
* Lubomir Marinov
|
||||||
Abilio Marques
|
* Abilio Marques
|
||||||
Abel Mathew
|
* Abel Mathew
|
||||||
Nick Mathewson
|
* Nick Mathewson
|
||||||
James Mansion
|
* James Mansion
|
||||||
Nicholas Marriott
|
* Nicholas Marriott
|
||||||
Andrey Matveev
|
* Andrey Matveev
|
||||||
Caitlin Mercer
|
* Caitlin Mercer
|
||||||
Dagobert Michelsen
|
* Dagobert Michelsen
|
||||||
Andrea Montefusco
|
* Andrea Montefusco
|
||||||
Mansour Moufid
|
* Mansour Moufid
|
||||||
Mina Naguib
|
* Mina Naguib
|
||||||
Felix Nawothnig
|
* Felix Nawothnig
|
||||||
Trond Norbye
|
* Trond Norbye
|
||||||
Linus Nordberg
|
* Linus Nordberg
|
||||||
Richard Nyberg
|
* Richard Nyberg
|
||||||
Jon Oberheide
|
* Jon Oberheide
|
||||||
Phil Oleson
|
* Phil Oleson
|
||||||
Dave Pacheco
|
* Dave Pacheco
|
||||||
Derrick Pallas
|
* Derrick Pallas
|
||||||
Tassilo von Parseval
|
* Tassilo von Parseval
|
||||||
Catalin Patulea
|
* Catalin Patulea
|
||||||
Patrick Pelletier
|
* Patrick Pelletier
|
||||||
Simon Perreault
|
* Simon Perreault
|
||||||
Dan Petro
|
* Dan Petro
|
||||||
Pierre Phaneuf
|
* Pierre Phaneuf
|
||||||
Amarin Phaosawasdi
|
* Amarin Phaosawasdi
|
||||||
Ryan Phillips
|
* Ryan Phillips
|
||||||
Dimitre Piskyulev
|
* Dimitre Piskyulev
|
||||||
Pavel Plesov
|
* Pavel Plesov
|
||||||
Jon Poland
|
* Jon Poland
|
||||||
Roman Puls
|
* Roman Puls
|
||||||
Nate R
|
* Nate R
|
||||||
Robert Ransom
|
* Robert Ransom
|
||||||
Bert JW Regeer
|
* Bert JW Regeer
|
||||||
Nate Rosenblum
|
* Nate Rosenblum
|
||||||
Peter Rosin
|
* Peter Rosin
|
||||||
Maseeb Abdul Qadir
|
* Maseeb Abdul Qadir
|
||||||
Wang Qin
|
* Wang Qin
|
||||||
Alex S
|
* Alex S
|
||||||
Gyepi Sam
|
* Gyepi Sam
|
||||||
Hanna Schroeter
|
* Hanna Schroeter
|
||||||
Ralf Schmitt
|
* Ralf Schmitt
|
||||||
Mike Smellie
|
* Mike Smellie
|
||||||
Kevin Springborn
|
* Kevin Springborn
|
||||||
Nir Soffer
|
* Nir Soffer
|
||||||
Harlan Stenn
|
* Harlan Stenn
|
||||||
Steve Snyder
|
* Steve Snyder
|
||||||
Dug Song
|
* Dug Song
|
||||||
Dongsheng Song
|
* Dongsheng Song
|
||||||
Hannes Sowa
|
* Hannes Sowa
|
||||||
Ferenc Szalai
|
* Joakim Soderberg
|
||||||
Brodie Thiesfield
|
* Ferenc Szalai
|
||||||
Jason Toffaletti
|
* Brodie Thiesfield
|
||||||
Gisle Vanem
|
* Jason Toffaletti
|
||||||
Bas Verhoeven
|
* Gisle Vanem
|
||||||
Constantine Verutin
|
* Bas Verhoeven
|
||||||
Colin Watt
|
* Constantine Verutin
|
||||||
Zack Weinberg
|
* Colin Watt
|
||||||
Jardel Weyrich
|
* Zack Weinberg
|
||||||
Jay R. Wren
|
* Jardel Weyrich
|
||||||
Zack Weinberg
|
* Jay R. Wren
|
||||||
Alejo
|
* Zack Weinberg
|
||||||
Alex
|
* Alejo
|
||||||
Taral
|
* Alex
|
||||||
propanbutan
|
* Taral
|
||||||
mmadia
|
* propanbutan
|
||||||
yangacer
|
* mmadia
|
||||||
|
* yangacer
|
||||||
|
|
||||||
If we have forgotten your name, please contact us.
|
If we have forgotten your name, please contact us.
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user