From 258c01ccc7086d0c58c74ab7d5b7fd0a6e6498b2 Mon Sep 17 00:00:00 2001 From: HorizonCode Date: Mon, 17 Oct 2022 21:30:46 +0200 Subject: [PATCH] add build from source section to readme --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index 6a0903a..462f258 100644 --- a/README.md +++ b/README.md @@ -19,5 +19,14 @@ The Launcher is a "plug and play thing", download it, place it on the desktop an * [axios](https://www.npmjs.com/package/axios) * [jquery](https://www.npmjs.com/package/jquery) +## Build from source + +- clone repo +- cd into the repo +- use `yarn install` to install all dependencies +- (if node-gyp cant build the natives try clearing the cache at `%localappdata%\node-gyp\Cache\`) +- run `yarn rebuild` to rebuild the natives to the current `NODE_MODULE_VERSION` +- use the buildscript `pack-win` to build a executeable + ## License [AGPL-3.0](https://choosealicense.com/licenses/agpl-3.0/) \ No newline at end of file