Update README.md with installation and updating instructions
This commit is contained in:
parent
69e8185992
commit
5c3c901c06
58
README.md
58
README.md
|
@ -1,3 +1,59 @@
|
|||
# hypnolive
|
||||
|
||||
Up-to-date Hypnospace pages from the internet!
|
||||
## Up-to-date Hypnospace pages from the internet!
|
||||
|
||||
Note: I plan on making this much more user-friendly later.
|
||||
|
||||
### Prerequisites
|
||||
#### Windows
|
||||
Look, I don't use Windows. I ran from it the second I had a chance. That said, this is the way I remember using Git.
|
||||
|
||||
* Hypnospace Outlaw (duh)
|
||||
* [Git for Windows](https://gitforwindows.org/)
|
||||
|
||||
#### Linux
|
||||
|
||||
* Hypnospace Outlaw (duh)
|
||||
* Git (install from your package manager)
|
||||
|
||||
### Installation
|
||||
#### Windows
|
||||
|
||||
* Open Git for Windows
|
||||
* Go to Hypnospace Outlaw's mod folder - Usually C:\Users\[yourusername]\Tendershoot\HypnOS\mods\
|
||||
* Clone this repository - git clone https://git.innovation-inc.org/Innovation/hypnolive
|
||||
|
||||
At this point, the mod will be made available in-game. Start the game!
|
||||
* Click the "Mods" button on whatever save file you're going to use. Check "Hypnolive"
|
||||
* Start the save file.
|
||||
|
||||
You will immediately have access to the Hypnolive zone. Welcome to Hypnolive!
|
||||
|
||||
#### Linux
|
||||
|
||||
* Go to Hypnospace Outlaw's mod folder - Usually ~/Tendershoot/HypnOS/mods/
|
||||
* Clone this repository - git clone https://git.innovation-inc.org/Innovation/hypnolive
|
||||
|
||||
At this point, the mod will be made available in-game. Start the game!
|
||||
* Click the "Mods" button on whatever save file you're going to use. Check "Hypnolive"
|
||||
* Start the save file.
|
||||
|
||||
You will immediately have access to the Hypnolive zone. Welcome to Hypnolive!
|
||||
|
||||
### Updating
|
||||
Eventually, this mod will keep itself up to date. However, during this experimental stage, it will require you to update it yourself.
|
||||
|
||||
#### Windows
|
||||
|
||||
* Open Git for Windows
|
||||
* Go to Hypnospace Outlaw's mod folder - Usually C:\Users\[yourusername]\Tendershoot\HypnOS\mods\
|
||||
* Pull the repository - git pull
|
||||
|
||||
The pages should automagically refresh.
|
||||
|
||||
#### Linux
|
||||
|
||||
* Go to Hypnospace Outlaw's mod folder - Usually ~/Tendershoot/HypnOS/mods/
|
||||
* Pull the repository - git pull
|
||||
|
||||
The pages should automagically refresh.
|
||||
|
|
Reference in a new issue