Skip to content

Commit 1f5fc97

Browse files
committed
Update README to match proper naming convention
1 parent 4a04911 commit 1f5fc97

File tree

1 file changed

+15
-3
lines changed

1 file changed

+15
-3
lines changed

readme.md

+15-3
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,25 @@
1-
# Collapse Launcher landing page
2-
Requires Node 20+
1+
# Collapse Launcher - Documentation Website
2+
3+
Contrary to the launcher itself, this repository serves as the official documentation platform for it. While we're not asking our users to read through the code, we've exposed it should anyone feel the need to peruse it to make improvements, or just for fun.
4+
5+
### System Requirements
6+
To run a local copy of the website, the user must have the following dependencies:
7+
8+
- OS: Windows, Mac OS X or Linux distribution which is still actively supported
9+
- Node: version 20 or higher
10+
11+
If submitting changes:
12+
13+
- Code editor of some sorts (VSCode or anything similar)
14+
- Git
315

416
Run the page locally:
517
```
618
npm install
719
npm run home:dev
820
```
921

10-
Before pushing that shiny commit button, please check if the build are okay or not
22+
Please make sure to test if the application builds locally before pushing any changes, by running the command below :) :
1123
```
1224
npm run home:build
1325
```

0 commit comments

Comments
 (0)