The simplest way to get started with Railroader is to just run it with no options in the root directory of your Rails application: cd your_rails_app/ railroader This will scan the application in the current directory and output a report to the command line. Alternatively, you can supply a path as an option to Railroader: railroader your_rails_app Even more specifically: railroader -p your_rails_app Railroader Options More documentation

Tests for Railroader are written using the standard library’s test/unit. The main test file is in test/test.rb. It can be run using ruby test/test.rb (or from any directory). Structure Railroader is tested by running it against full Rails applications and then checking the reported warnings. test/test.rb #Main test runner test/apps/ #Apps to check against test/tests/ #Actual tests There are several Rails applications, including: test/apps/rails2 #Rails 2.3.11 test/apps/rails3 #Rails 3.

Rails applications tend to be complex and processing all possible scenarios is nearly impossible. Railroader is built with reliability in mind and always attempts to at least generate a report. Unfortunately, that can some times hide problems. Hopefully the information on this page can help when things go awry. Remember, you can always open an issue or ask on Gitter to get help. Problems Parsing Errors Railroader “Hangs” More documentation