From 2e05e5d7404844d734fefb0a8f176828cdad5508 Mon Sep 17 00:00:00 2001 From: b1ek Date: Sat, 22 Apr 2023 20:29:17 +1000 Subject: [PATCH] add build instructions --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 2d9676f..2c0a720 100644 --- a/README.md +++ b/README.md @@ -4,3 +4,13 @@ Resume.JS is an in-browser CLI emulator that acts as my resume. Perhaps you could use this codebase to make your own resume without wasting a few days on implementing basic terminal. This was originally a part of [homepage.js](https://git.blek.codes/blek/homepage.js), but I decided to move it to an external repository. + +# Building +```sh +$ git clone git.blek.codes/blek/resume.js resume && cd resume +$ yarn install +$ yarn build +``` + +This project uses `yarn` to manage dependencies, and it must be used instead of `npm`. +However, you can use `npm`, but it is not guaranteed that everything will work fine if you use it. \ No newline at end of file