summaryrefslogtreecommitdiff
path: root/_cs/README
diff options
context:
space:
mode:
Diffstat (limited to '_cs/README')
-rw-r--r--_cs/README18
1 files changed, 18 insertions, 0 deletions
diff --git a/_cs/README b/_cs/README
new file mode 100644
index 000000000..7aac73161
--- /dev/null
+++ b/_cs/README
@@ -0,0 +1,18 @@
+This directory contains the Coding Standard tests to be used with PHP
+CodeSniffer on DokuWiki's code.
+
+1. Install PHP CodeSniffer:
+
+ #> pear install PHP_CodeSniffer
+
+2. Link the Coding Standard to the CodeSniffer directory:
+
+ #> ln -s /path/to/dokuwiki/_cs/DokuWiki /usr/share/pear/PHP/CodeSniffer/Standards/DokuWiki
+
+3. Set DokuWiki to be the default standard:
+
+ #> phpcs --config-set default_standard DokuWiki
+
+
+
+The coding standard is work in progress.