diff --git a/README.md b/README.md index bcf2d123..559d641a 100644 --- a/README.md +++ b/README.md @@ -88,113 +88,12 @@ This section details the setup of a basic developmentment environment. --- -**Clone and Install Dependencies** - -```console -> git clone https://github.com/luki-39/LukiEnLiveLauncher.git -> cd LukiEnLiveLauncher -> npm install -``` - ---- - -**Launch Application** - -```console -> npm start -``` - ---- - -**Build Installers** - -To build for your current platform. - -```console -> npm run dist -``` - -Build for a specific platform. - -| Platform | Command | -| ----------- | -------------------- | -| Windows x64 | `npm run dist:win` | -| macOS | `npm run dist:mac` | -| Linux x64 | `npm run dist:linux` | - -Builds for macOS may not work on Windows/Linux and vice-versa. - ---- - -### Visual Studio Code - -All development of the launcher should be done using [Visual Studio Code][vscode]. - -Paste the following into `.vscode/launch.json` - -```JSON -{ - "version": "0.2.0", - "configurations": [ - { - "name": "Debug Main Process", - "type": "node", - "request": "launch", - "cwd": "${workspaceFolder}", - "program": "${workspaceFolder}/node_modules/electron/cli.js", - "args" : ["."], - "outputCapture": "std" - }, - { - "name": "Debug Renderer Process", - "type": "chrome", - "request": "launch", - "runtimeExecutable": "${workspaceFolder}/node_modules/.bin/electron", - "windows": { - "runtimeExecutable": "${workspaceFolder}/node_modules/.bin/electron.cmd" - }, - "runtimeArgs": [ - "${workspaceFolder}/.", - "--remote-debugging-port=9222" - ], - "webRoot": "${workspaceFolder}" - } - ] -} -``` - -This adds two debug configurations. - -#### Debug Main Process - -This allows you to debug Electron's [main process][mainprocess]. You can debug scripts in the [renderer process][rendererprocess] by opening the DevTools Window. - -#### Debug Renderer Process - -This allows you to debug Electron's [renderer process][rendererprocess]. This requires you to install the [Debugger for Chrome][chromedebugger] extension. - -Note that you **cannot** open the DevTools window while using this debug configuration. Chromium only allows one debugger, opening another will crash the program. - ---- - -### Note on Third-Party Usage - -Please give credit to the original author and provide a link to the original source. This is free software, please do at least this much. - -For instructions on setting up Microsoft Authentication, see https://github.com/luki-39/LukiEnLiveLauncher/blob/master/docs/MicrosoftAuth.md. - ---- - ## Resources * [Wiki][wiki] * [Nebula (Create Distribution.json)][nebula] * [v2 Rewrite Branch (Inactive)][v2branch] -The best way to contact the developers is on Discord. - -[![discord](https://discordapp.com/api/guilds/211524927831015424/embed.png?style=banner3)][discord] - --- ### See you ingame.