Skip to content

Commit e43cb53

Browse files
authored
Update README.md
1 parent 44806b1 commit e43cb53

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,32 @@
11
# Launcher
2+
3+
Launcher is a Minecraft custom launcher developped to launch the game with our own modpack.
4+
5+
More info on: [https://altarik.fr](https://altarik.fr) [^1]
6+
7+
[^1]: Website still in developpement, a new fresh version will come in a near future.
8+
9+
## Preambule
10+
11+
Use main branch at your own risk, it may contains code which not compile nor contains known bugs which require bug fix.
12+
13+
If you want to use a version of the launcher how work, please download an already compiled asset from the lastest version ([https://github.com/AltarikMC/Launcher/releases/latest](https://github.com/AltarikMC/Launcher/releases/latest)) or checkout the latest tag.
14+
15+
## Installation and usage
16+
17+
If you use the launcher thank to git and not by downloading already compiled assets[^2], use these step:
18+
19+
[^2]: If you using a Mac per example.
20+
21+
First you need to have nodejs installed on your system, if not, install it by following this page: [https://nodejs.org/en/download/
22+
](https://nodejs.org/en/download/).
23+
24+
Then active yarn if you don't have already did it: `corepack enable`
25+
26+
To install dependencies: `yarn`
27+
28+
To start the launcher: `yarn run start`
29+
30+
## Copyright
31+
32+
The code and everything here is distributed under BSD 3-Clause License which autorize usage, modification and dsitribution of the launcher for a commercial or a private use, more information about the [licence here](https://github.com/AltarikMC/Launcher/blob/master/LICENSE).

0 commit comments

Comments
 (0)