Skip to content

Commit 004432d

Browse files
committed
Update README and add .nvmrc
1 parent 3d0dae1 commit 004432d

File tree

2 files changed

+31
-13
lines changed

2 files changed

+31
-13
lines changed

.nvmrc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
16.20.2

readme.md

Lines changed: 30 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,30 @@
1-
<h1>Sploder Launcher</h1>
2-
A project that aims to revive <a href="https://sploder.com">sploder</a>.<br>
3-
Join the <a href="https://discord.gg/cHGz362sdC">Discord server</a>!
4-
<h1>How to use:</h1>
5-
- Download the <a href="https://github.com/Sploder-Saptarshi/Sploder-Launcher/releases/latest">latest release</a> from here.<br>
6-
- Run the installer.<br>
7-
- Done.<br>
8-
<h1>How to build:</h1>
9-
- Use node 14.10.0.<br>
10-
- Install yarn.<br>
11-
- Install all the required packages by running <code>yarn</code>.<br>
12-
- Run <code>build</code> or build.bat.
13-
- The built files will be available in the dist folder.
1+
# Sploder Launcher
2+
3+
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.
4+
5+
Join the [Discord Server](https://discord.gg/cHGz362sdC) for the active community and development.
6+
7+
## Using without releases
8+
9+
- Download the [latest release](https://github.com/Sploder-Saptarshi/Sploder-Launcher/releases/latest)
10+
- Run the installer
11+
12+
## How to build
13+
14+
### Dependencies
15+
16+
- [node.js](https://nodejs.org/en)
17+
- [node version manager (nvm)](https://github.com/nvm-sh/nvm)
18+
19+
### Steps to Build
20+
21+
- Run `nvm use` to switch to the node version specified in .nvmrc
22+
- Run `npm i` to install all necessary packages
23+
- Run `npm run dist` to build the project
24+
- The built files will be available in the dist folder.
25+
26+
### Steps to Debug
27+
28+
- Run `nvm use` to switch to the node version specified in .nvmrc
29+
- Run `npm i` to install all necessary packages
30+
- Run `npm run dev` to start the electron development server

0 commit comments

Comments
 (0)