Merge branch 'release' of https://github.com/SangeloDev/SangeFault into release

This commit is contained in:
Sangelo 2021-05-07 11:57:01 +02:00
commit a585f86b2d

58
README.md Normal file
View file

@ -0,0 +1,58 @@
# SangeFault
## Installation Instructions
Hello there! Thanks for trying out world's first complex open-source Minecraft resourcepack for 1.8.9 first of all! I am very thankful for that :D.
Now let's go on to the installation instructions:
### Easy Install
Recommended for users who are scared of the command line.
Instructions:
1. Go to the releases tab or click [this link](https://github.com/SangeloDev/SangeFault/releases) and download the latest version.
2. Unzip the zip file.
3. Windows:
- Press WIN+R together on your keyboard.
- Type in `%appdata%` and click `Run`.
- Go into your Minecraft folder (eg. `.minecraft`) and then into `resourcepacks`
- Paste in the zip file which was **inside** the zip file you downloaded earlier.
Mac:
- Open a Finder window.
- Press `⌘ + ⇧ + G`, type in `~/Library/Application\ Support/` and press enter.
- Locate your Minecraft folder (eg. `.minecraft`) and open it.
- Locate the `resourcepacks` folder and open it.
- Paste in the zip file which was **inside** the zip you downloaded earlier.
Linux:
- Go to your Minecraft path: /home/`username`/`minecraft path (eg. .minecraft)`
- Locate the `resourcepacks` folder and open it.
- Paste in the zip file which was **inside** the zip you downloaded earlier.
4. Start Minecraft and enjoy!
### Hard Install
For the ones that would like to flex 😎.
1. Open a Command Promt (Windows) or Terminal (Mac & Linux).
2. Type in `cd [path to your minecraft resourcepack folder*]`
3. Type `git clone https://github.com/SangeloDev/SangeFault`
4. Start Minecraft and enjoy!
## Update Instructions
This is how you update my pack to the latest release. This pack is far from finished, y'know?
### Easy Installation (Only do if you used the Easy Installation Method!)
1. Download the latest release
2. Follow the installation instructions for your os.
3. Start Minecraft and enjoy!
### Hard Installation (Only possible with the Hard Installation Method!)
1. Open a Command Prompt (Windows) or a Terminal (Mac & Linux)
2. Type in `cd [path to your minecraft resourcepack folder*] && git pull`
3. Start Minecraft and enjoy!
## Release naming system
Since release 1.0.3, I am using a naming system for releases, since this pack is still WIP.
I'll be naming:
- Major releases (1.0, 1.1, etc.) as MR
- Minor releases (1.0.1, 1.1.4, etc.) as mR
- Patches (1.0.2.1, etc.) as PR
(May be changed in the future)
#### *Follow the Easy Installation Instructions to find your directory if you don't know where it is.