diff --git a/Release-Branches.md b/Release-Branches.md new file mode 100644 index 0000000..77b85aa --- /dev/null +++ b/Release-Branches.md @@ -0,0 +1,28 @@ +- **master (Default/Stable):** It has been tested by users on develop branch and it's not known to have any major issues. + + +- **develop (Beta):** Dev releases are beta releases. These builds have been tested by nightly testers and should contain only minor issues. + +- **nightly (Nightly):** Bleeding edge builds. Appveyor builds that generate automatically with every push to develop branch. There is no guarantee that it will even run in some cases. ***Use this branch only if you know what you are doing and are willing to get your hands dirty to recover a failed update.*** + +## How to change your branch ## + +#### For Built-In Updater #### + +1. Go to Settings and then the General tab and show advanced settings (use the toggle by the save button). + +2. Under the Development section change the branch name to `develop` or `nightly` + +3. Save + +_This will not install the bits from that branch immediately, it will happen during the next update._ + +## Installing a newer version ## + +1. Go to System and then the Updates tab + +2. Newer versions that are not yet installed will have an update button next to them, clicking that button will install the update. + +## Can I switch from develop back to master? ## +We don't recommend manually switching back to master, since other branches are commonly running newer code which might not be compatible with the older code in master. +We have plans to mitigate this in the future. \ No newline at end of file