aboutsummaryrefslogtreecommitdiffstats
path: root/tools/xmlValidator
diff options
context:
space:
mode:
authorDavid Wagner <david.wagner@intel.com>2014-03-06 14:58:29 +0100
committerDavid Wagner <david.wagner@intel.com>2014-09-10 12:04:36 +0200
commitf811b7b53c0c2f0d4320c70230e609619c5087c1 (patch)
treee96266eb13098f5a82aef2d3079b626653706dd2 /tools/xmlValidator
parente8088d0f60d895a733c00953c0fdd4e9daf0b279 (diff)
downloadexternal_parameter-framework-f811b7b53c0c2f0d4320c70230e609619c5087c1.zip
external_parameter-framework-f811b7b53c0c2f0d4320c70230e609619c5087c1.tar.gz
external_parameter-framework-f811b7b53c0c2f0d4320c70230e609619c5087c1.tar.bz2
More README files
- More details in the root README.md file; add a nice diagram - Add a lot of README files in subdirectories Signed-off-by: David Wagner <david.wagner@intel.com>
Diffstat (limited to 'tools/xmlValidator')
-rw-r--r--tools/xmlValidator/README.md13
1 files changed, 8 insertions, 5 deletions
diff --git a/tools/xmlValidator/README.md b/tools/xmlValidator/README.md
index adc7e12..11d64a6 100644
--- a/tools/xmlValidator/README.md
+++ b/tools/xmlValidator/README.md
@@ -1,13 +1,14 @@
# xmlValidator tool
This tool can be used to check if the `.xml` files you have written are
-following the `.xsd` schemas we provided you.
-By doing so, you are *ensured* that your configuration is *fully compatible* with the `parameter-framework`.
+following the `.xsd` schemas provided by the PFW. By doing so, you are *ensured*
+that your configuration is *fully compatible* with the `parameter-framework`.
It scans all directories and subdirectories for `.xml` files and checks them
with `.xsd` from a *schemas* directory you specified for the script.
## Usage
+
To run xmlValidator, just start it from the commandline with:
python xmlValidator.py <xmlRootDirectory> <xsdDirectory>
@@ -66,8 +67,10 @@ And we will get the following output on the commandline:
## Install requirements
-In order to use this tool, you must have the following packages installed:
-* `python`
+In order to use this tool, you must have the following packages (these
+are the names on a debian-based distribution):
+
+* `python` (2.7 or later)
* `python-lxml`
-* `libpython2.7`
+* `libpython2.7` or later