From 25b0016c9f7e255e05a28f5da6e7db6311b6b596 Mon Sep 17 00:00:00 2001 From: Michael Drake Date: Sat, 8 Aug 2015 12:03:25 +0100 Subject: Add a README file. --- README.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 README.md (limited to 'README.md') diff --git a/README.md b/README.md new file mode 100644 index 0000000..5513710 --- /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 -- cgit v1.2.3