Skip to content

Commit

Permalink
Update links to clone/download
Browse files Browse the repository at this point in the history
  • Loading branch information
budak7273 committed Oct 10, 2024
1 parent df19659 commit b81a74f
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 18 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -9,18 +9,21 @@ or you will have to repeat some of the setup process again.

== What Branch to Clone

// When updating the below, remember to update StaterProjectViaClone.adoc, StarterProjectViaZip.adoc, and dependencies.adoc (engine)
====
This is the *development* version of the docs.
This is the *latest stable* version of the docs.
// This is the *development* version of the docs.
Stable (Release) and Experimental are currently both the same version - 1.0 Release.
Clone the **`master` branch** to develop a mod for SML 3.8.0.
// You should clone the **`dev` branch** because SML 3.8.? is not released yet.
// You should clone either the **`dev` branch** or the **`master` branch**.
// Of those two, you probably want whichever branch was pushed to most recently, which you can see
// https://github.com/satisfactorymodding/SatisfactoryModLoader/branches[on the GitHub repository].
// If you're still uncertain which to clone, ask us on the Discord.
You should clone the **`dev` branch** because SML 3.8 is not released yet.
If you're uncertain about which branch to clone, **ask us on the Discord**.
====

https://github.com/satisfactorymodding/SatisfactoryModLoader/[Here] is a link to the repository to clone.
Expand All @@ -37,6 +40,12 @@ about good long-term homes for your starter project files.

The directory is ready for use as soon as the clone is complete.

[IMPORTANT]
====
Many Git clients will automatically clone the repository's default branch.
Make sure it has actually cloned the branch you intended to before proceeding.
====

== Next Steps

Now that all the dependencies are installed, you can move onto
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,27 +8,24 @@ or you will have to repeat some of the setup process again.

== What Version to Download

// When updating the below, remember to update StaterProjectViaClone.adoc, StarterProjectViaZip.adoc, and dependencies.adoc (engine)
====
This is the *development* version of the docs.
This is the *latest stable* version of the docs.
// This is the *development* version of the docs.
Stable (Release) and Experimental are currently both the same version - 1.0 Release.
Download a zip of the **`master` branch** to develop a mod for SML 3.8.0
by clicking https://github.com/satisfactorymodding/SatisfactoryModLoader/archive/refs/heads/master.zip[here].
// Download a zip of the **`dev` branch** (because SML 3.8.? is not released yet)
// by clicking https://github.com/satisfactorymodding/SatisfactoryModLoader/archive/refs/heads/dev.zip[here].
// You should download a zip either of the **`dev` branch** or the **`master` branch**.
// Of those two, you probably want whichever branch was pushed to most recently, which you can see
// https://github.com/satisfactorymodding/SatisfactoryModLoader/branches[on the GitHub repository].
// If you're still uncertain which to download, **ask us on the Discord**.
// If you choose to download the `dev` branch, click
// https://github.com/satisfactorymodding/SatisfactoryModLoader/archive/refs/heads/dev.zip[here].
// If you choose to download the `master` branch, click
// https://github.com/satisfactorymodding/SatisfactoryModLoader/archive/refs/heads/master.zip[here].
You should download a zip of the **`dev` branch** because SML 3.8 is not released yet.
To download a zip of the dev branch, click
https://github.com/satisfactorymodding/SatisfactoryModLoader/archive/refs/heads/dev.zip[here].
If you're uncertain about which branch to download, **ask us on the Discord**.
====

== Unzipping the Files
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -178,8 +178,10 @@ The below box will contain a link to the specific release that you should downlo
It's imperative that you download the correct engine for the version of the game you're modding
or you will have to repeat a large amount of the setup process again.

// When updating the below, remember to update StaterProjectViaClone.adoc, StarterProjectViaZip.adoc, and dependencies.adoc (engine)
====
This is the *development* version of the docs.
This is the *latest stable* version of the docs.
// This is the *development* version of the docs.
Stable (Release) and Experimental are currently both the same version - 1.0 Release.
Expand Down

0 comments on commit b81a74f

Please sign in to comment.