From 1ec847ed5ebd3b28bc1929b011eed190450a6727 Mon Sep 17 00:00:00 2001
From: Tom Elliott <tomelliottnz@gmail.com>
Date: Tue, 21 Jan 2025 21:29:16 +1300
Subject: [PATCH] add readme

---
 tests/testthat/sampler/README.md | 41 ++++++++++++++++++++++++++++++++
 1 file changed, 41 insertions(+)
 create mode 100644 tests/testthat/sampler/README.md

diff --git a/tests/testthat/sampler/README.md b/tests/testthat/sampler/README.md
new file mode 100644
index 0000000..edee7a9
--- /dev/null
+++ b/tests/testthat/sampler/README.md
@@ -0,0 +1,41 @@
+# Demo app
+
+1. Installing R and the the `ts` package
+
+```r
+devtools::install_github("tmelliott/ts")
+```
+
+2. Install node and npm (or pnpm!), then install dependencies
+
+```bash
+pnpm install
+```
+
+3. Build dependencies
+
+```bash
+pnpm build
+```
+
+4. Start Rserve in a separate terminal
+
+```bash
+pnpm rserve
+```
+
+5. Run the app
+
+```bash
+pnpm start
+```
+
+You should see some output in the terminal:
+
+```bash
+Running sampler script...
+
+Mean: 3
+First char: hello
+Sample num: Float64Array(2) [ 4, 3, r_type: 'double_array' ]
+```