From 4727913b31397cc3ce50791dd4605e225652d33b Mon Sep 17 00:00:00 2001 From: Sylvie Date: Mon, 4 Dec 2023 16:31:38 -0700 Subject: [PATCH] docs: added local install notes --- docs/install/local.md | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/docs/install/local.md b/docs/install/local.md index ce285f8..a1b19f8 100644 --- a/docs/install/local.md +++ b/docs/install/local.md @@ -1,3 +1,20 @@ # Local install -Local installation with Node.js \ No newline at end of file +The local method uses the [Node.js](https://nodejs.org/en) installation found on your system. + +## Requirements + +- **Node 20** or later +- [pnpm](https://pnpm.io/installation) + +## Install + +```bash +git clone -b dev/0.15.0 https://github.com/tycrek/ass.git && cd ass/ +pnpm i +# or: npm i -D +pnpm run dev + +# After ass has been compiled, you can instead use: +pnpm run start +```