Преглед на файлове

Update README for tests

Christopher Mullins преди 6 години
родител
ревизия
30e05e5b1a
променени са 1 файла, в които са добавени 14 реда и са изтрити 0 реда
  1. 14 0
      test/remote/README.md

+ 14 - 0
test/remote/README.md

@@ -0,0 +1,14 @@
+## Integration Tests
+
+This integration test suite is built using rspec.  It integrates with espMH in a variety of ways, and monitors externally visible behaviors and states to ensure they match expectations.
+
+### Setup
+
+1. Copy `settings.json.example` to `settings.json` and make appropriate modifications for your setup.
+1. Copy `espmh.env.example` to `espmh.env` and make appropriate modifications.  For MQTT tests, you will need an external MQTT broker.
+1. Install ruby and the bundler gem.
+1. Run `bundle install`.
+
+### Running
+
+Run the tests using `bundle exec rspec`.