Skip to content
This repository was archived by the owner on Apr 13, 2025. It is now read-only.

Commit f59817d

Browse files
authored
Merge pull request #53 from codeoverflow-org/feature/183-debughelper
Add sample doc for debug service
2 parents b39bf00 + 3c0e142 commit f59817d

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

docs/samples/debug.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
## Using the Debug sample bundle
2+
3+
The Debug Helper example bundle in `samples/debug` demonstrates the ability to use the debug helper to send same sample data to your bundle so you can trigger different features and test/debug them.
4+
5+
### Prerequisites
6+
7+
- Working NodeCG & nodecg-io installation
8+
9+
### Configure the Debug sample bundle
10+
11+
1. Start NodeCG with with nodecg-io installed. The Debug sample bundle is currently part of it, so it should also be loaded.
12+
2. Login using your password. If this is your first run, then enter the password with which you want to encrypt your configurations and credentials.
13+
3. Create a new Debug service instance using the left upper menu.
14+
4. Set the Deubg service instance to the service dependency of the Debug sample bundle.
15+
Select the Debug sample bundle the the Debug service in the left bottom menu and then select the service instance that should be used by the Debug sample bundle (in this case the name of the previously created Debug instance).
16+
5. Go to the nodecg-io-debug dashboard and use some buttons or other inputs.
17+
6. Check the nodecg log. It should contain a message for each action you did and the passed values.

0 commit comments

Comments
 (0)