Skip to content

Commit

Permalink
added some notes about how to do development
Browse files Browse the repository at this point in the history
  • Loading branch information
markwpearce committed Aug 9, 2024
1 parent bf8ae2f commit 80181a4
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,27 @@ Rooibos is an independent open-source project maintained exclusively by voluntee

You might want to help! Get in touch via the [slack group](https://join.slack.com/t/rokudevelopers/shared_invite/zt-4vw7rg6v-NH46oY7hTktpRIBM_zGvwA) or [raise issues](https://github.com/rokucommunity/rooibos/issues/new).

### Project Setup

1. Clone the project
2. Run `npm install`
3. Open the workspace file in VSCode: `roobois.code-workspace`

### Running Tests

Rooibos Brighterscript plugin tests can be run either through VSCode's debug configuration `Run Tests (bsc-plugin)` or by running `npm run test` in the directory `rooibos/bsc-plugin`.

Example Rooibos framework tests will wrun on a Roku device.

Create a `.env` in `rooibos/tests` with the following details:

```
ROKU_HOST=<ip of Roku device>
ROKU_PASSWORD=<development password of Roku device>
```

Run tests either from a VSCode debugger, or through `npm run test`.

## Sample project

https://github.com/rokucommunity/rooibos-roku-sample
Expand Down

0 comments on commit 80181a4

Please sign in to comment.