summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMichael Drake <tlsa@netsurf-browser.org>2015-08-08 11:03:25 (GMT)
committer Michael Drake <tlsa@netsurf-browser.org>2015-08-08 11:03:25 (GMT)
commit25b0016c9f7e255e05a28f5da6e7db6311b6b596 (patch)
tree9f2158ee288d7530d8158d317def3680f51a6a60
parent012fde5b18d708ffe298400f4b91a7f1449751c3 (diff)
downloadlibnslayout-25b0016c9f7e255e05a28f5da6e7db6311b6b596.tar.gz
libnslayout-25b0016c9f7e255e05a28f5da6e7db6311b6b596.tar.bz2
Add a README file.
-rw-r--r--README.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..5513710
--- a/dev/null
+++ b/README.md
@@ -0,0 +1,27 @@
+
+LibNSLayout: The NetSurf browser layout engine
+==============================================
+
+This is being written to replace NetSurf's old built-in render code, which
+had a number of issues. Most notably it was unable to handle dynamic changes
+to the document.
+
+Dependencies
+------------
+
+LibNSLayout requires LibDOM and LibCSS from the NetSurf browser project.
+
+
+Building
+--------
+
+Follow NetSurf's QUICK-START document to get and build the project's other
+libraries. With your `env/sh` sourced run the following commands:
+
+ $ make
+ $ make test
+ $ make install
+
+Or to test in debug mode:
+
+ $ make VARIANT=debug test