README.md

PlaceOS Drivers

Manage and test PlaceOS drivers.

Development

harness

harness is a helper for easing development of PlaceOS Drivers.

Usage: ./harness [-h|--help] [command]

Helper script for interfacing with the PlaceOS Driver spec runner

Command:
    report                  check all drivers' compilation status
    up                      starts the harness
    down                    stops the harness
    build                   builds drivers and uploads them to S3
    format                  formats driver code
    help                    display this message

To spin up the test harness, clone the repository and run...

$ ./harness up

Point a browser to localhost:8085, and you're good to go.

When the environment is not in use, remember to run...

$ ./harness down

Before committing, please run...

$ ./harness format

Documentation

• Existing Driver Docs
• Writing a PlaceOS Driver
• Testing a PlaceOS Driver
• Sending Emails
• Environment Setup
• Runtime Debugging
• Directory Structure
• PlaceOS Spec Runner HTTP API

Contributing

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request