Skip to content

Commit

Permalink
build.md update
Browse files Browse the repository at this point in the history
  • Loading branch information
mienaiyami committed Nov 14, 2023
1 parent 0dadb9f commit 0b65aca
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions docs/build.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,13 @@
# Build Guide

Require `node@v18.15.0` and `yarn`.
Require `git`, `node@v18.15.0` and `yarn`.

```bash

git clone https://github.com/mienaiyami/yomikiru/

cd yomikiru

# install dependencies
yarn install

Expand All @@ -15,4 +20,4 @@ yarn run make

Check [package.json](https://github.com/mienaiyami/yomikiru/blob/a9431648c7d5c6cce82f8572ea2948d37e40f729/package.json#L20), [forge.config.ts -> makers](https://github.com/mienaiyami/yomikiru/blob/a9431648c7d5c6cce82f8572ea2948d37e40f729/forge.config.ts#L42) and <https://www.electronforge.io/config/makers> for more options.

Feel free to ask any questions regarding building using issues. I don't have much experience with different linux distros the code might not work on all out of the box.
Feel free to ask any questions regarding building using issues. I don't have much experience with different linux distros the code might not work on all out of the box.

0 comments on commit 0b65aca

Please sign in to comment.