aboutsummaryrefslogtreecommitdiff
path: root/exampleData/ruleSets/README
diff options
context:
space:
mode:
Diffstat (limited to 'exampleData/ruleSets/README')
-rw-r--r--exampleData/ruleSets/README15
1 files changed, 15 insertions, 0 deletions
diff --git a/exampleData/ruleSets/README b/exampleData/ruleSets/README
new file mode 100644
index 0000000..48d55ff
--- /dev/null
+++ b/exampleData/ruleSets/README
@@ -0,0 +1,15 @@
+# Example FiveUI Guidelines
+
+This directory contains various FiveUI rule sets aimed at general websites.
+
+## Files
+
+colorRules.json : rules for checking color
+fontRules.json : rules checking font family/weight/size
+imageRules.json : rules checking image sizes and borders
+miscRules.json : rules checking misc constraints
+textRules.json : rules checking text style
+
+buildCombinedRules.sh : shell script which merges all the .json files in
+ the current directory into the file combinedRules.json
+combinedRules.json : collection of all the above rules in one file