From 184438b99af08f71cd04fb5f9518c0b90462b5b8 Mon Sep 17 00:00:00 2001 From: Daniel Oaks Date: Sat, 1 Jul 2017 22:43:15 +1000 Subject: [PATCH] readme: Explain new stable branch and go over building more completely --- README.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index d389fee8..b9835795 100644 --- a/README.md +++ b/README.md @@ -61,14 +61,18 @@ You can also install this repo and use that instead! However, keep some things i `devel` branches are intentionally unstable, containing fixes that may not work, and they may be rebased or reworked extensively. -The `master` branch _should_ usually be stable, but may contain database changes that either have not been finalised or not had database upgrade code written yet. Don't run `master` on a live production network. If you'd like to, run the latest tagged version in production instead. +The `master` branch _should_ usually be stable, but may contain database changes that either have not been finalised or not had database upgrade code written yet. Don't run `master` on a live production network. -from the root folder, run make (for all target systems/release) +The `stable` branch contains the latest release. You can run this for a production version without any trouble. + +#### Building + +Clone the appropriate branch. From the root folder, run `make` to generate all release files for all of our target OSes: ``` make ``` -or restrict to a specific target system +You can also only build the release files for a specific system: ``` # for windows make windows @@ -83,6 +87,8 @@ make osx make arm6 ``` +Once you have made the release files, you can find them in the `build` directory. Uncompress these to an empty directory and continue as usual. + ## Configuration The default config file [`oragono.yaml`](oragono.yaml) helps walk you through what each option means and changes. The configuration's intended to be sparse, so if there are options missing it's either because that feature isn't written/configurable yet or because we don't think it should be configurable.