Skip to content
This repository was archived by the owner on Jun 8, 2022. It is now read-only.

Commit a338013

Browse files
committed
added minimal README
1 parent caf7342 commit a338013

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

README

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
This is the distributed build system for Minecraft-Overviewer.
2+
3+
Running `worker.py` will launch a Gearman worker that will fetch,
4+
build and upload Overviewer packages on command. Usually these
5+
commands come in the form of a `!build` command issued in the
6+
#overviewer IRC channel.
7+
8+
`worker.py` will autodetect what system you are on, and act
9+
accordingly. Currently supported systems are Windows, Debian, and
10+
OSX. Of course, you will need to be able to compile and run
11+
Overviewer, but you will also need a few extra things.
12+
13+
* `git` is used to fetch the packages. You must have it.
14+
15+
* `python-gearman` to communicate with the master gearman server. Use
16+
eminence's `testing` branch to prevent most random disconnections:
17+
18+
https://github.com/eminence/python-gearman/tree/testing
19+
20+
* The build system password, in either `secret_key.txt` or the
21+
`SECRET_KEY` environment variable. If you're setting up a build
22+
machine, this will be provided to you.
23+
24+
* Some way of uploading, somewhere. Currently included uploaders are
25+
for an S3 account and for overviewer.org. The overviewer.org
26+
uploader needs an SSH key, which can be provided if you're setting
27+
up a build machine.
28+
29+
Depending on the system, some extra things may be needed that aren't
30+
listed here. Debian, for instance, needs the debian package tools
31+
installed.
32+
33+
This may or may not be useful to anyone else, or even anyone at all. YMMV.

0 commit comments

Comments
 (0)