From b7cc4f18961bd067d8d23df854c245bd99b2deeb Mon Sep 17 00:00:00 2001 From: Carl Hetherington Date: Fri, 29 May 2015 19:13:28 +0100 Subject: Use markdown for README. --- README | 38 -------------------------------------- README.md | 38 ++++++++++++++++++++++++++++++++++++++ 2 files changed, 38 insertions(+), 38 deletions(-) delete mode 100644 README create mode 100644 README.md diff --git a/README b/README deleted file mode 100644 index 0f333ff..0000000 --- a/README +++ /dev/null @@ -1,38 +0,0 @@ -libcxml -------- - -This is a very small library which provides a slightly tidier -C++ API than libxml++ for parsing HTML. - -For example: - -cxml::Document doc ("RootNodeName"); -doc.read ("foo.xml"); - -/* Get the contents of child node , throwing an - * exception if it does not exist - */ -string s = doc.string_child ("Fred"); - -/* Get the contents of child node , or 42 if it - * does not exist - */ -int i = doc.optional_number_child ("Jim").get_value_or (42); - -/* Get the contents of within , - * throwing an exception if either node - * is not present. - */ -double d = doc.node_child("Sheila").number_child ("Roger"); - -For full details, see src/cxml.h - -To build: -./waf configure -./waf build -sudo ./waf install - -Bug reports and queries to Carl Hetherington - - - diff --git a/README.md b/README.md new file mode 100644 index 0000000..3d4da80 --- /dev/null +++ b/README.md @@ -0,0 +1,38 @@ +libcxml +======= + +This is a very small library which provides a slightly tidier +C++ API than libxml++ for parsing HTML. + +For example: + + cxml::Document doc ("RootNodeName"); + doc.read ("foo.xml"); + + /* Get the contents of child node , throwing an + * exception if it does not exist + */ + string s = doc.string_child ("Fred"); + + /* Get the contents of child node , or 42 if it + * does not exist + */ + int i = doc.optional_number_child ("Jim").get_value_or (42); + + /* Get the contents of within , + * throwing an exception if either node + * is not present. + */ + double d = doc.node_child("Sheila").number_child ("Roger"); + +For full details, see src/cxml.h + +To build: +./waf configure +./waf build +sudo ./waf install + +Bug reports and queries to Carl Hetherington + + + -- cgit v1.2.3