Update README.md
dblume commited on 2024-03-02 09:59:36
Showing 1 changed files, with 25 additions and 7 deletions.
- README.md 8d8a630..655b113
| ... | ... |
@@ -5,22 +5,40 @@ It uses SceneGraph and the BrightScript language. |
| 5 | 5 |
|
| 6 | 6 |
# Getting the project |
| 7 | 7 |
|
| 8 |
-You can get a copy of this project by clicking on the |
|
| 9 |
-[ZIP](https://git.dlma.com/roku_ip_tagger.git/zipball/main) |
|
| 10 |
-or [TAR](https://git.dlma.com/roku_ip_tagger.git/tarball/main) buttons |
|
| 11 |
-near the top right of the GitList web page. |
|
| 8 |
+At [git.dlma.com](https://git.dlma.com/roku_ip_tagger.git) click Download and select Download ZIP or Download TAR. |
|
| 12 | 9 |
|
| 13 | 10 |
If you're me, and you want to contribute to the repo, then you can clone it like so: |
| 14 | 11 |
|
| 15 |
- git clone ssh://USERNAME@dlma.com/~/git/roku_ip_tagger.git |
|
| 12 |
+ git clone ssh://$USER@dlma.com/~/git/roku_ip_tagger.git |
|
| 16 | 13 |
|
| 17 | 14 |
# Building it |
| 18 | 15 |
|
| 19 |
-In the components directory, move the file "[settings.xml.sample](https://git.dlma.com/roku_ip_tagger.git/blob/main/components/settings.xml.sample)" to "settings.xml" and update its `url` and `auth` fields. |
|
| 20 |
- |
|
| 21 | 16 |
[Ensure you can sideload a dev channel](https://sdkdocs.roku.com/display/sdkdoc/Loading+and+Running+Your+Application). |
| 22 | 17 |
Then see the "build\_systems" command in ip\_tagger.sublime-project to see how the channel is zipped and deployed. |
| 23 | 18 |
|
| 19 |
+In the components directory, move the file "[settings.xml.sample](https://git.dlma.com/roku_ip_tagger.git/blob/main/components/settings.xml.sample)" |
|
| 20 |
+to "settings.xml" and update its `url` and `auth` fields. |
|
| 21 |
+ |
|
| 22 |
+It is convenient to set environment variables `$ROKU_DEV_TARGET` and `$DEVPASSWORD` in a local file ".env". For example: |
|
| 23 |
+ |
|
| 24 |
+ ROKU_DEV_TARGET=192.168.1.2 |
|
| 25 |
+ DEVPASSWORD=mooltipass |
|
| 26 |
+ |
|
| 27 |
+### CLI |
|
| 28 |
+ |
|
| 29 |
+Running make will build and deploy if you have `$ROKU_DEV_TARGET` and `$DEVPASSWORD` set. |
|
| 30 |
+ |
|
| 31 |
+ make |
|
| 32 |
+ |
|
| 33 |
+You can automatically make and deploy with each changed file with the following command: |
|
| 34 |
+ |
|
| 35 |
+ git ls-files | entr -c sh -c 'make all' |
|
| 36 |
+ |
|
| 37 |
+### VS Code |
|
| 38 |
+ |
|
| 39 |
+VS Code can also use the Makefile with [VC Code Makefile Tools](https://marketplace.visualstudio.com/items?itemName=ms-vscode.makefile-tools). |
|
| 40 |
+ |
|
| 41 |
+ |
|
| 24 | 42 |
# Corresponding Server Code |
| 25 | 43 |
|
| 26 | 44 |
Here's [the corresponding server code](https://git.dlma.com/kvs.git/). |
| 27 | 45 |