GitHub/ergo
3
0
Fork 0
mirror of https://github.com/ergochat/ergo.git synced 2024-12-23 03:02:48 +01:00
Code Issues Projects Releases Wiki Activity

readme: Explain new stable branch and go over building more completely

Browse Source
This commit is contained in:
Daniel Oaks 2017-07-01 22:43:15 +10:00
parent 3db81be7e3
commit 184438b99a
1 changed files with 9 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -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.