add build instructions

This commit is contained in:
b1ek 2023-04-22 20:29:17 +10:00
parent 53813967ed
commit 2e05e5d740
Signed by: blek
GPG Key ID: 14546221E3595D0C
1 changed files with 10 additions and 0 deletions

View File

@ -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.