Add some new conversions.
[libcxml.git] / README.md
index d3505201d66798c0bc821ec5d501bf47b573aa6e..13b70bf9f23d58925b623194aa11d1a44a3d8a9f 100644 (file)
--- a/README.md
+++ b/README.md
@@ -6,33 +6,46 @@ C++ API than libxml++ for parsing HTML.
 
 For example:
 
-    cxml::Document doc ("RootNodeName");
-    doc.read ("foo.xml");
+    cxml::Document doc("RootNodeName");
+    doc.read("foo.xml");
 
     /* Get the contents of child node <Fred>, throwing an
      * exception if it does not exist
      */
-    string s = doc.string_child ("Fred");
+    string s = doc.string_child("Fred");
 
     /* Get the contents of child node <Jim>, or 42 if it
      * does not exist
      */
-    int i = doc.optional_number_child<int> ("Jim").get_value_or (42);
+    int i = doc.optional_number_child<int>("Jim").get_value_or(42);
 
     /* Get the contents of <Roger> within <Sheila>,
      * throwing an exception if either node
      * is not present.
      */
-    double d = doc.node_child("Sheila").number_child<double> ("Roger");
+    double d = doc.node_child("Sheila").number_child<double>("Roger");
 
 For full details, see src/cxml.h
 
-To build:
+Building
+-------
+
     ./waf configure
     ./waf build
     sudo ./waf install
 
-Bug reports and queries to Carl Hetherington <cth@carlh.net>
+### Build options
+
+    --target-windows      set up to do a cross-compile to Windows
+    --enable-debug        build with debugging information and without optimisation
+    --static              build statically
+    --disable-tests       disable building of tests
+    --force-cpp11         force use of C++11
 
+### Dependencies
 
+- libxml++ (and libffi)
 
+
+---
+Bug reports and queries to Carl Hetherington <cth@carlh.net>