summaryrefslogtreecommitdiffstats
path: root/html/README.md
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--html/README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/html/README.md b/html/README.md
new file mode 100644
index 0000000..0902433
--- /dev/null
+++ b/html/README.md
@@ -0,0 +1,14 @@
+## Prerequisites
+
+> **NOTE:** yarn v2 is required.
+
+Install [Yarn](https://yarnpkg.com/getting-started/install), and run: `yarn install`.
+
+## Development
+
+1. Start ttyd: `ttyd bash`
+2. Start the dev server: `yarn run start`
+
+## Publish
+
+Run `yarn run build`, this will compile the inlined html to `../src/html.h`.