diff --git a/.nvmrc b/.nvmrc new file mode 100644 index 0000000..cb406c6 --- /dev/null +++ b/.nvmrc @@ -0,0 +1 @@ +16.20.2 diff --git a/readme.md b/readme.md index f3089d9..84fd3e3 100644 --- a/readme.md +++ b/readme.md @@ -1,13 +1,30 @@ -
yarn.build or build.bat.
-- The built files will be available in the dist folder.
+# Sploder Launcher
+
+A repository that aims to provide a standalone application to be able to access the Sploder-Revival project without needing to install Flash or downgraded applications system wide.
+
+Join the [Discord Server](https://discord.gg/cHGz362sdC) for the active community and development.
+
+## Using without releases
+
+- Download the [latest release](https://github.com/Sploder-Saptarshi/Sploder-Launcher/releases/latest)
+- Run the installer
+
+## How to build
+
+### Dependencies
+
+ - [node.js](https://nodejs.org/en)
+ - [node version manager (nvm)](https://github.com/nvm-sh/nvm)
+
+### Steps to Build
+
+ - Run `nvm use` to switch to the node version specified in .nvmrc
+ - Run `npm i` to install all necessary packages
+ - Run `npm run dist` to build the project
+ - The built files will be available in the dist folder.
+
+### Steps to Debug
+
+ - Run `nvm use` to switch to the node version specified in .nvmrc
+ - Run `npm i` to install all necessary packages
+ - Run `npm run dev` to start the electron development server