tools/robot_check/README.markdown

   1 # Robot Tidy Tool
   2
   3 Tool for checking and correcting Robot Framework code formatting.
   4
   5 ## Installation
   6
   7 The `robot.tidy` Python module ships with the Robot Framework Python package.
   8
   9 We recommend using a [Virtual Environment][1] to manage Python modules.
  10
  11     $ mkvirtualenv tidy
  12     $ pip install -r requirements.txt
  13
  14 ## Usage
  15
  16 The `tidy.sh` script is a wrapper around `robot.tidy` that checks all files in
  17 the Integration/Test repository.
  18
  19 Use the `check` argument to report problems without correcting them.
  20
  21     $ ./tidy.sh check
  22
  23 Use the `tidy` argument to automatically clean up all problems.
  24
  25     $ ./tidy.sh tidy
  26
  27 [1]: https://virtualenvwrapper.readthedocs.io/en/latest/ "Virtualenvwrapper docs"