From bb314462609ac3417b48697e9341232af097bab3 Mon Sep 17 00:00:00 2001 From: Atul Varma Date: Wed, 3 Feb 2021 20:14:15 -0500 Subject: [PATCH] Update README. --- README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/README.md b/README.md index 184859f..144feee 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,26 @@ All art is by [Nina Paley][]! +## Quick start + +This requires [NodeJS][]. It was started with +NodeJS 14.15.4, but hopefully it should work with +any recent version. + +After cloning the repository and entering it, run: + +``` +npm run watch +``` + +then visit http://localhost:1234. + +## Deployment + +To deploy the project to GitHub Pages, run: + +``` +npm run deploy +``` + +[NodeJS]: https://nodejs.org/en/ [Nina Paley]: https://blog.ninapaley.com/