summaryrefslogtreecommitdiffstats
path: root/tools/checkwps/README
diff options
context:
space:
mode:
Diffstat (limited to 'tools/checkwps/README')
-rw-r--r--tools/checkwps/README23
1 files changed, 23 insertions, 0 deletions
diff --git a/tools/checkwps/README b/tools/checkwps/README
new file mode 100644
index 0000000000..a94882fdff
--- /dev/null
+++ b/tools/checkwps/README
@@ -0,0 +1,23 @@
+This directory contains the checkwps tool which can be used to
+validate wps files outside of Rockbox.
+
+checkwps uses the Rockbox WPS parser and is therefore built in
+target-specific versions (to avoid making lots of changes to the core
+code).
+
+To compile
+----------
+
+Just run the ./buildall.sh script
+
+
+To remove all compiled files
+----------------------------
+
+./cleanall.sh
+
+
+To add a new target
+-------------------
+
+Add $target and $modelname from tools/configure to targets.txt