Parker2991/Funkin
1
0
Fork 0
mirror of https://github.com/FunkinCrew/Funkin.git synced 2024-11-26 17:46:08 -05:00
Code Issues Projects Releases Packages Wiki Activity

Add ZIP button warning and restructured sentences

Browse source 
Each step should be easier to follow with this structure
This commit is contained in:
Hundrec 2024-06-15 13:37:21 -04:00 committed by EliteMasterEric
parent 2916bd6ff7
commit 9fb4a8719a
1 changed files with 7 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
docs/COMPILING.md
View file

@ -3,12 +3,13 @@
0. Setup 0. Setup
- Download Haxe from [Haxe.org](https://haxe.org) - Download Haxe from [Haxe.org](https://haxe.org)
- Download Git from [git-scm.com](https://www.git-scm.com) - Download Git from [git-scm.com](https://www.git-scm.com)
1. Cloning the Repository: Make sure when you clone, you clone the submodules to get the assets repo: - Do NOT download the repository using the Download ZIP button on GitHub or you may run into errors!
- `git clone --recurse-submodules https://github.com/FunkinCrew/funkin.git` - Instead, open a command prompt and do the following steps...
- If you accidentally cloned without the `assets` submodule (aka didn't follow the step above), you can run `git submodule update --init --recursive` to get the assets in a foolproof way. 1. Run `git clone --recurse-submodules https://github.com/FunkinCrew/funkin.git` to clone the repository with the necessary assets submodule
2. Install `hmm` (run `haxelib --global install hmm` and then `haxelib --global run hmm setup`) - _If you accidentally cloned without the `assets` submodule (aka didn't follow the step above), you can run `git submodule update --init --recursive` to get the assets in a foolproof way._
3. Install all haxelibs of the current branch by running `hmm install` 2. Run `haxelib --global install hmm` and then `haxelib --global run hmm setup` to install hmm.json
4. Setup lime: `haxelib run lime setup` 3. Run `hmm install` to install all haxelibs of the current branch
4. Run `haxelib run lime setup` to set up lime
5. Platform setup 5. Platform setup
- For Windows, download the [Visual Studio Build Tools](https://aka.ms/vs/17/release/vs_BuildTools.exe) - For Windows, download the [Visual Studio Build Tools](https://aka.ms/vs/17/release/vs_BuildTools.exe)
- When prompted, select "Individual Components" and make sure to download the following: - When prompted, select "Individual Components" and make sure to download the following: