aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJason A. Donenfeld <Jason@zx2c4.com>2011-05-16 19:39:04 -0400
committerJason A. Donenfeld <Jason@zx2c4.com>2011-05-16 19:39:04 -0400
commit49108fa6ea9847f72f8d1aa3bdc469b627367f5b (patch)
tree608eb57b2f5af9ab8cdfd0ab784888531b63bf22
parentAdd headless wrapper example. (diff)
downloadServerExecute-49108fa6ea9847f72f8d1aa3bdc469b627367f5b.tar.xz
ServerExecute-49108fa6ea9847f72f8d1aa3bdc469b627367f5b.zip
Add readme.
-rw-r--r--README40
1 files changed, 40 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..dd638e0
--- /dev/null
+++ b/README
@@ -0,0 +1,40 @@
+====================|=============|========================
+====================|ServerExecute|========================
+====================|=============|========================
+ ~~~~~~~|~~~~~~~~~~~~~|~~~~~~~~
+ ~~~~~~~| by zx2c4 |~~~~~~~~
+ ~~~~~~~|~~~~~~~~~~~~~|~~~~~~~~
+ \ /
+ \ /
+ \ /
+ \ /
+ \ /
+ \ /
+ \ /
+ ^
+ web 2.0
+
+ServerExecute is a simple program written in Qt. It makes
+use of QtWebKit. It fetches a webpage, executes all the
+JavaScript, and waits for all AJAX requests to be
+completed. It then returns compliant HTML as if the site
+did not rely on AJAX in the first place. This is designed
+as a simple alternative to using more cumbersome projects
+like HtmlUnit that rely on Java.
+
+##### Requirements #####
+* Qt, from http://qt.nokia.com
+* Xvfb, if running an unpatched Qt on a headless server
+
+##### Compilation #####
+$ qmake
+$ make
+$ ./ServerExecute http://zx2c4.com
+...
+
+##### Notes on Headless #####
+QtWebKit requires an X server. You can patch this using
+various patches available on the Internet, or you can use
+a simple in-memory X server buffer called Xvfb. See the
+included example script on how to do this. It is trivial.
+