Docs and minor usability fixes for robot.tidy tool

[integration/test.git] / tools / robot_check / README.markdown

diff --git a/tools/robot_check/README.markdown b/tools/robot_check/README.markdown
new file mode 100644 (file)
index 0000000..2701885
--- /dev/null
+++ b/tools/robot_check/README.markdown
@@ -0,0 +1,27 @@
+# Robot Tidy Tool
+
+Tool for checking and correcting Robot Framework code formatting.
+
+## Installation
+
+The `robot.tidy` Python module ships with the Robot Framework Python package.
+
+We recommend using a [Virtual Environment][1] to manage Python modules.
+
+    $ mkvirtualenv tidy
+    $ pip install -r requirements.txt
+
+## Usage
+
+The `tidy.sh` script is a wrapper around `robot.tidy` that checks all files in
+the Integration/Test repository.
+
+Use the `check` argument to report problems without correcting them.
+
+    $ ./tidy.sh check
+
+Use the `tidy` argument to automatically clean up all problems.
+
+    $ ./tidy.sh tidy
+
+[1]: https://virtualenvwrapper.readthedocs.io/en/latest/ "Virtualenvwrapper docs"