From 0f2b1b73d13ca4a601b6e5a7bfe59fc9b75cab28 Mon Sep 17 00:00:00 2001 From: Qi-rui Chen Date: Wed, 9 Jan 2019 12:47:55 +0000 Subject: [PATCH] Update README with better instructions --- README.md | 39 +++++++++++++++++++++++++++++++-------- 1 file changed, 31 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index c40a835..1a781da 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,35 @@ -# ExpandedMagnorbs +# [ExpandedMagnorbs](https://steamcommunity.com/sharedfiles/filedetails/?id=746884345) -Expanded Magnorbs is a modification for Starbound, by Azulaloi Champagne. -If you found this build on the Expanded Magnorbs GitHub repo, follow the following instructions to install. -Move the /az-expandedmagnorbs/ directory into your /Starbound/mods/ directory, such that the location of this file reads as follows: -/Starbound/mods/az-expandedmagnorbs/README.md +Expanded Magnorbs is a modification for Starbound, by [Azulaloi Champagne](https://steamcommunity.com/id/azulaloi). The reccomended way to install this mod is through the [steam workshop](https://steamcommunity.com/sharedfiles/filedetails/?id=746884345). + +![Ooh, fancy!](_previewimage) + +## Alternate Install + +The master branch of this repository is used for developemnt, and contents could be unstable, unfinished, or otherwise subject to change. [Stable realeases](https://github.com/qqii/ExpandedMagnorbs/releases) are tagged, and uploaded to the steam workshop. + +### Obtaining Files + +The files can be obtained in three ways, through the [steam workshop](https://steamcommunity.com/sharedfiles/filedetails/?id=746884345), by downlading a `zip` archive from the github website or by cloning the repository through `git`. It is reccomended to simply subscribe through the [steam workshop](https://steamcommunity.com/sharedfiles/filedetails/?id=746884345) if you are only looking to play the latest version. Obtaining files from this github repository is only suggested if you would like to play an [older version](https://github.com/Azulaloi/ExpandedMagnorbs/releases), try the latest deveopment build or contribute to the project. + +### Prerequisites + +* [Starbound](https://store.steampowered.com/app/211820/Starbound/) installed +* [`git`](https://git-scm.com/downloads) installed +**OR** +* [zip extractor](https://www.7-zip.org/download.html) installed + +#### Download Zip + +* Download the repository as a `zip` by clicking `Clone or download` followed by [`Download ZIP`](https://github.com/Azulaloi/ExpandedMagnorbs/archive/master.zip) +OR +* Download the version from the [releases tab](https://github.com/Azulaloi/ExpandedMagnorbs/releases) that you are looking for. +* Extract the archive into your starbound folder `/Starbound/mods/az-expandedmagnorbs/` such that location of this file reads as follows: `/Starbound/mods/az-expandedmagnorbs/README.md` + +#### Git + +* Clone the repository into `/Starbound/mods/` + -If you recieved this build directory from the steam workshop page, it should have automatically been installed properly. -Builds found on the GitHub repo may be a development build. Contents could be unstable, unfinished, or otherwise subject to change. -Builds obtained directly from the steam workshop are always stable releases.