aboutsummaryrefslogtreecommitdiff
path: root/examples/scalariform-example/README.md
diff options
context:
space:
mode:
authorrockjam <5min4eq.unity@gmail.com>2016-06-20 13:38:38 +0300
committerrockjam <5min4eq.unity@gmail.com>2016-06-20 14:35:48 +0300
commit07d3b85e98b4cc86c9f685c1096469cf6eca9cbb (patch)
tree17b022ef5e8154869b0b33ae881a25b87be7faf7 /examples/scalariform-example/README.md
parentf834052e2825cb283399c14eb626f05d73b73759 (diff)
downloadcbt-07d3b85e98b4cc86c9f685c1096469cf6eca9cbb.tar.gz
cbt-07d3b85e98b4cc86c9f685c1096469cf6eca9cbb.tar.bz2
cbt-07d3b85e98b4cc86c9f685c1096469cf6eca9cbb.zip
scalariform plugin naive implementation
Diffstat (limited to 'examples/scalariform-example/README.md')
-rw-r--r--examples/scalariform-example/README.md5
1 files changed, 5 insertions, 0 deletions
diff --git a/examples/scalariform-example/README.md b/examples/scalariform-example/README.md
new file mode 100644
index 0000000..e599b5b
--- /dev/null
+++ b/examples/scalariform-example/README.md
@@ -0,0 +1,5 @@
+This example shows integration with scalariform plugin.
+Reformat executed on every `cbt compile` call, and affects only *.scala source files.
+You can provide your custom scalariform preferences in build via `scalariformPreferences`.
+To test formatting in action you can execute: `cbt breakFormatting` to break formatting
+and `cbt scalariformReformat` to get formatting back.