Updated README

This commit is contained in:
Eddoursul 2021-10-07 03:47:40 +02:00
parent 2b1bb48605
commit ce81e827d1

View File

@ -2,7 +2,6 @@
## Requirements ## Requirements
- Skyrim Special Edition 1.5.97 - Skyrim Special Edition 1.5.97
- Creation Club mods must be moved to a separate mod and disabled.
- [SKSE64 build 2.0.19](https://skse.silverlock.org/) - [SKSE64 build 2.0.19](https://skse.silverlock.org/)
- [SkyUI SE](https://www.nexusmods.com/skyrimspecialedition/mods/12604) - [SkyUI SE](https://www.nexusmods.com/skyrimspecialedition/mods/12604)
- [JContainers SE](https://www.nexusmods.com/skyrimspecialedition/mods/16495) - [JContainers SE](https://www.nexusmods.com/skyrimspecialedition/mods/16495)
@ -11,6 +10,7 @@
## How to play ## How to play
- Add a Skyrim SE instance to Mod Organizer 2. - Add a Skyrim SE instance to Mod Organizer 2.
- Install all requirements. - Install all requirements.
- Creation Club mods must be moved to a separate mod and disabled.
- Copy `E - Sounds.bsa`, `L - Voices.bsa`, and the `Video` directory to a new mod in MO2. - Copy `E - Sounds.bsa`, `L - Voices.bsa`, and the `Video` directory to a new mod in MO2.
- This repository uses LFS to store binary files, run `git lfs install` before cloning it. - This repository uses LFS to store binary files, run `git lfs install` before cloning it.
- Clone this repository, move it to `mods`. - Clone this repository, move it to `mods`.
@ -31,13 +31,11 @@ In short, the suggested workflow looks like this:
Here is the process in detail. Here is the process in detail.
All patches and assets must be committed to `development` and its sub-branches. ESP patches are allowed here. Keep in mind, other patches may interfere with your changes, you may want to test your patches in a separate sub-branch and merge it into `development` later. All ESP patches and assets must be committed to `development` and its sub-branches. Keep in mind, other patches may interfere with your changes, you may want to test your patches in a separate sub-branch and merge it into `development` later.
The `development` branch is merged to `merging`, fully or through cherry-picking. ESP patches should be merged into ESMs here, English string files must also follow all changes. The `development` branch is merged to `merging`, fully or through cherry-picking. ESP patches should be merged into ESMs here, English string files must also follow all changes.
Commits, having all ESPs merged in and removed from `merging`, can be forwarded from `merging` into `master`. Completed merges (with all ESPs merged in and removed) should be forwarded from `merging` to `master` and back into `development`, removing merged ESPs and updating ESMs without touching other patches.
Merging commits can be cherry-picked from `merging` back into `development`, removing merged in ESPs and updating ESMs without touching other patches.
`master` must always have a playable copy of the game without any additional patches. `master` must always have a playable copy of the game without any additional patches.