From d46955d9422a2b500010647ccfebda85ac1a3d62 Mon Sep 17 00:00:00 2001
From: Boris Kolpackov <boris@codesynthesis.com>
Date: Wed, 27 Sep 2023 09:48:38 +0200
Subject: Replace package README with README.md, rewrite content

---
 xsd-examples/README    | 21 ---------------------
 xsd-examples/README.md | 11 +++++++++++
 xsd-examples/buildfile |  2 +-
 xsd-examples/manifest  |  2 +-
 4 files changed, 13 insertions(+), 23 deletions(-)
 delete mode 100644 xsd-examples/README
 create mode 100644 xsd-examples/README.md

(limited to 'xsd-examples')

diff --git a/xsd-examples/README b/xsd-examples/README
deleted file mode 100644
index 023334d..0000000
--- a/xsd-examples/README
+++ /dev/null
@@ -1,21 +0,0 @@
-This package contains a number of examples that show how to use XSD, the
-XML Schema to C++ data binding compiler and the generated C++ Tree and
-Parser classes. See the README files in example directories for more
-information on each example.
-
-The package source code is in the public domain.
-
-The project page is at https://www.codesynthesis.com/projects/xsd/.
-
-The easiest way to build this package is with the bpkg package manager:
-
-$ mkdir xsd-examples/
-$ cd xsd-examples/
-$ bpkg create cc
-$ bpkg build xsd-examples@https://pkg.cppget.org/1/stable
-
-But if you don't want to use the package manager, then you can also build it
-manually using the standard build2 build system.
-
-Send bug reports or any other feedback to the xsd-users@codesynthesis.com
-mailing list.
diff --git a/xsd-examples/README.md b/xsd-examples/README.md
new file mode 100644
index 0000000..e55a3ee
--- /dev/null
+++ b/xsd-examples/README.md
@@ -0,0 +1,11 @@
+# xsd-examples - examples for XSD compiler
+
+This package contains examples for `xsd`, the XML Schema to C++ data binding
+compiler.
+
+The C++/Tree and C++/Parser mapping examples can be found in the `cxx/tree/`
+and `cxx/parser/` subdirectories, respectively. For the summary of available
+examples for each mapping, see `cxx/tree/README` and `cxx/parser/README`,
+respectively. Each example also comes with its own `README` file that provides
+a detailed description of the functionality shown as well as the steps to
+build and run it.
diff --git a/xsd-examples/buildfile b/xsd-examples/buildfile
index 3f8fb1b..f9b2d06 100644
--- a/xsd-examples/buildfile
+++ b/xsd-examples/buildfile
@@ -1,4 +1,4 @@
 # file      : buildfile
 # license   : not copyrighted - public domain
 
-./: {*/ -build/} doc{README} legal{UNLICENSE} manifest
+./: {*/ -build/} doc{README.md} legal{UNLICENSE} manifest
diff --git a/xsd-examples/manifest b/xsd-examples/manifest
index 7e02b59..c3528e8 100644
--- a/xsd-examples/manifest
+++ b/xsd-examples/manifest
@@ -6,7 +6,7 @@ type: examples
 language: c++
 summary: XML Schema to C++ data binding compiler examples
 license: Unlicence
-description-file: README
+description-file: README.md
 url: https://www.codesynthesis.com/projects/xsd/
 doc-url: https://www.codesynthesis.com/projects/xsd/
 src-url: https://git.codesynthesis.com/cgit/xsd/xsd/tree/xsd-examples/
-- 
cgit v1.1