aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorStefan Bühler <stbuehler@web.de>2013-05-29 14:02:25 +0200
committerStefan Bühler <stbuehler@web.de>2013-05-29 14:02:25 +0200
commit88c9f6a2b098f26d53d46e3d5db5dfafc758fdf1 (patch)
tree65ff3edd6a15f3823107c825151f24f1aacfbb08
parent6ab271d046052a6824fa7d429ccbba130c773578 (diff)
downloadfcgi-debug-88c9f6a2b098f26d53d46e3d5db5dfafc758fdf1.tar.gz
fcgi-debug-88c9f6a2b098f26d53d46e3d5db5dfafc758fdf1.zip
make README a markdown formatted README.md
-rw-r--r--README14
-rw-r--r--README.md37
2 files changed, 37 insertions, 14 deletions
diff --git a/README b/README
deleted file mode 100644
index 08467db..0000000
--- a/README
+++ /dev/null
@@ -1,14 +0,0 @@
-
-fcgi-debug helps you to trace what happens with your fastcgi programs without having to strace them;
-it just sits between webserver and your fastcgi program and forwards all content while analysing it.
-
-Build Requires:
- glib2
- libev
- cmake
-
-For running you probably want spawn-fcgi (either from lighttpd, or from https://cgit.stbuehler.de/gitosis/spawn-fcgi/about/)
-
-Example usage (assuming the binary is in build/fcgi-debug, starts a fastcgi server listening on port 1026):
-
- spawn-fcgi -C 0 -p 1026 -n -- build/fcgi-debug /usr/bin/php5-cgi
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..567707f
--- /dev/null
+++ b/README.md
@@ -0,0 +1,37 @@
+Description
+-----------
+
+**Homepage**: http://redmine.lighttpd.net/projects/fcgi-debug/wiki
+
+fcgi-debug helps you to trace what happens with your fastcgi programs without having to strace them;
+it just sits between webserver and your fastcgi program and forwards all content while analysing it.
+
+
+Usage
+-----
+
+Example usage (assuming the binary is in build/fcgi-debug, starts a fastcgi server listening on port 1026):
+
+<pre>
+spawn-fcgi -C 0 -p 1026 -n -- build/fcgi-debug /usr/bin/php5-cgi
+</pre>
+
+
+Build dependencies
+------------------
+
+ * [glib2 >= 2.12](https://git.gnome.org/browse/glib)
+ * [libev](http://software.schmorp.de/pkg/libev.html)
+ * cmake
+
+For running you probably want [spawn-fcgi](http://redmine.lighttpd.net/projects/spawn-fcgi/wiki).
+
+
+Build
+-----
+
+<pre>
+git clone git://git.lighttpd.net/fcgi-debug.git
+cd fcgi-debug
+(mkdir build && cd build && cmake .. && make)
+</pre>