summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJoakim Soderberg <joakim.soderberg@gmail.com>2014-01-14 18:24:43 +0100
committerJoakim Soderberg <joakim.soderberg@gmail.com>2014-01-14 18:24:43 +0100
commitd2bc39afd0a45ec44e5a3a30ffba0f3f3473b1a1 (patch)
tree23e5bda291fecf643398a15232ceaa55c12e4c6c /README.md
parent24d646666b3d85ff65fbdd5c1a29e3dc5c6f6e09 (diff)
downloadlibevent-d2bc39afd0a45ec44e5a3a30ffba0f3f3473b1a1.tar.gz
Rename README to README.md and use markdown to format.
Diffstat (limited to 'README.md')
-rw-r--r--README.md225
1 files changed, 225 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 00000000..3dfa10a3
--- /dev/null
+++ b/README.md
@@ -0,0 +1,225 @@
+0. BUILDING AND INSTALLATION (Briefly)
+
+$ ./configure
+$ make
+$ make verify # (optional)
+$ sudo make install
+
+1. BUILDING AND INSTALLATION (In Depth)
+
+To build libevent, type
+
+$ ./configure && make
+
+ (If you got libevent from the git repository, you will
+ first need to run the included "autogen.sh" script in order to
+ generate the configure script.)
+
+You can run the regression tests by running
+
+$ make verify
+
+Install as root via
+
+# make install
+
+Before reporting any problems, please run the regression tests.
+
+To enable the low-level tracing build the library as:
+
+ CFLAGS=-DUSE_DEBUG ./configure [...]
+
+Standard configure flags should work. In particular, see:
+
+ --disable-shared Only build static libraries
+ --prefix Install all files relative to this directory.
+
+
+The configure script also supports the following flags:
+
+ --enable-gcc-warnings Enable extra compiler checking with GCC.
+ --disable-malloc-replacement
+ Don't let applications replace our memory
+ management functions
+ --disable-openssl Disable support for OpenSSL encryption.
+ --disable-thread-support Don't support multithreaded environments.
+
+2. USEFUL LINKS:
+
+For the latest released version of Libevent, see the official website at
+http://libevent.org/ .
+
+There's a pretty good work-in-progress manual up at
+ http://www.wangafu.net/~nickm/libevent-book/ .
+
+For the latest development versions of Libevent, access our Git repository
+via
+ "git clone git://levent.git.sourceforge.net/gitroot/levent/libevent"
+
+You can browse the git repository online at
+http://levent.git.sourceforge.net/git/gitweb-index.cgi .
+
+To report bugs, request features, or submit patches to Libevent,
+use the Sourceforge trackers at
+https://sourceforge.net/tracker/?group_id=50884 .
+
+There's also a libevent-users mailing list for talking about Libevent
+use and development: http://archives.seul.org/libevent/users/
+
+3. ACKNOWLEDGMENTS
+
+The following people have helped with suggestions, ideas, code or
+fixing bugs:
+
+ Samy Al Bahra
+ Jacob Appelbaum
+ Arno Bakker
+ Weston Andros Adamson
+ William Ahern
+ Ivan Andropov
+ Sergey Avseyev
+ Avi Bab
+ Joachim Bauch
+ Gilad Benjamini
+ Stas Bekman
+ Denis Bilenko
+ Julien Blache
+ Kevin Bowling
+ Tomash Brechko
+ Kelly Brock
+ Ralph Castain
+ Adrian Chadd
+ Lawnstein Chan
+ Shuo Chen
+ Ka-Hing Cheung
+ Andrew Cox
+ Paul Croome
+ George Danchev
+ Andrew Danforth
+ Ed Day
+ Christopher Davis
+ Mike Davis
+ Antony Dovgal
+ Mihai Draghicioiu
+ Alexander Drozdov
+ Mark Ellzey
+ Shie Erlich
+ Leonid Evdokimov
+ Juan Pablo Fernandez
+ Christophe Fillot
+ Mike Frysinger
+ Remi Gacogne
+ Artem Germanov
+ Alexander von Gernler
+ Artur Grabowski
+ Diwaker Gupta
+ Sebastian Hahn
+ Dave Hart
+ Greg Hazel
+ Nicholas Heath
+ Michael Herf
+ Sebastian Hahn
+ Savg He
+ Mark Heily
+ Maxime Henrion
+ Michael Herf
+ Greg Hewgill
+ Andrew Hochhaus
+ Aaron Hopkins
+ Tani Hosokawa
+ Jamie Iles
+ Xiuqiang Jiang
+ Claudio Jeker
+ Evan Jones
+ George Kadianakis
+ Phua Keat
+ Azat Khuzhin
+ Alexander Klauer
+ Kevin Ko
+ Brian Koehmstedt
+ Marko Kreen
+ Valery Kyholodov
+ Ross Lagerwall
+ Scott Lamb
+ Christopher Layne
+ Adam Langley
+ Graham Leggett
+ Volker Lendecke
+ Philip Lewis
+ Zhou Li
+ David Libenzi
+ Yan Lin
+ Moshe Litvin
+ Simon Liu
+ Mitchell Livingston
+ Hagne Mahre
+ Lubomir Marinov
+ Abilio Marques
+ Abel Mathew
+ Nick Mathewson
+ James Mansion
+ Nicholas Marriott
+ Andrey Matveev
+ Caitlin Mercer
+ Dagobert Michelsen
+ Andrea Montefusco
+ Mansour Moufid
+ Mina Naguib
+ Felix Nawothnig
+ Trond Norbye
+ Linus Nordberg
+ Richard Nyberg
+ Jon Oberheide
+ Phil Oleson
+ Dave Pacheco
+ Derrick Pallas
+ Tassilo von Parseval
+ Catalin Patulea
+ Patrick Pelletier
+ Simon Perreault
+ Dan Petro
+ Pierre Phaneuf
+ Amarin Phaosawasdi
+ Ryan Phillips
+ Dimitre Piskyulev
+ Pavel Plesov
+ Jon Poland
+ Roman Puls
+ Nate R
+ Robert Ransom
+ Bert JW Regeer
+ Nate Rosenblum
+ Peter Rosin
+ Maseeb Abdul Qadir
+ Wang Qin
+ Alex S
+ Gyepi Sam
+ Hanna Schroeter
+ Ralf Schmitt
+ Mike Smellie
+ Kevin Springborn
+ Nir Soffer
+ Harlan Stenn
+ Steve Snyder
+ Dug Song
+ Dongsheng Song
+ Hannes Sowa
+ Ferenc Szalai
+ Brodie Thiesfield
+ Jason Toffaletti
+ Gisle Vanem
+ Bas Verhoeven
+ Constantine Verutin
+ Colin Watt
+ Zack Weinberg
+ Jardel Weyrich
+ Jay R. Wren
+ Zack Weinberg
+ Alejo
+ Alex
+ Taral
+ propanbutan
+ mmadia
+ yangacer
+
+If we have forgotten your name, please contact us.