From 80181a4008df10776bf546aad22f0856736b5496 Mon Sep 17 00:00:00 2001
From: Mark Pearce <mark.pearce@redspace.com>
Date: Fri, 9 Aug 2024 15:45:20 -0300
Subject: [PATCH] added some notes about how to do development

---
 README.md | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)

diff --git a/README.md b/README.md
index 2279275e..e2718226 100644
--- a/README.md
+++ b/README.md
@@ -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