summaryrefslogtreecommitdiffstats
path: root/html/README.md
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-19 02:54:31 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-19 02:54:31 +0000
commit3b4936b6f2b870f9f2444ebb6ce1ca2de3f49d9f (patch)
treec91ab0ac9447b25f91c05e901212c2142fb95953 /html/README.md
parentInitial commit. (diff)
downloadttyd-3b4936b6f2b870f9f2444ebb6ce1ca2de3f49d9f.tar.xz
ttyd-3b4936b6f2b870f9f2444ebb6ce1ca2de3f49d9f.zip
Adding upstream version 1.7.4.upstream/1.7.4
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'html/README.md')
-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`.