README.md 1.43 KB
Newer Older
Matthias Schiffer's avatar
Matthias Schiffer committed
1
Documentation (incomplete at this time, contribute if you can!) may be found at
2
https://gluon.readthedocs.org/.
Matthias Schiffer's avatar
Matthias Schiffer committed
3
4

If you're new to Gluon and ready to get your feet wet, have a look at the
5
[Getting Started Guide](https://gluon.readthedocs.org/en/latest/user/getting_started.html).
Matthias Schiffer's avatar
Matthias Schiffer committed
6

7
**Gluon IRC channel: `#gluon` in [hackint](https://hackint.org/)**
Matthias Schiffer's avatar
Matthias Schiffer committed
8
9
10

## Issues & Feature requests

11
Before opening an issue, make sure to check whether any existing issues
Matthias Schiffer's avatar
Matthias Schiffer committed
12
13
14
(open or closed) match. If you're suggesting a new feature, drop by on IRC or
our mailinglist to discuss it first.

Matthias Schiffer's avatar
Matthias Schiffer committed
15
16
17
We maintain a [Roadmap](https://github.com/freifunk-gluon/gluon/wiki/Roadmap) for
the future development of Gluon.

Matthias Schiffer's avatar
Matthias Schiffer committed
18
19
## Use a release!

20
Please refrain from using the `master` branch for anything else but development purposes!
Matthias Schiffer's avatar
Matthias Schiffer committed
21
Use the most recent release instead. You can list all releases by running `git tag`
22
and switch to one by running `git checkout v2018.1.1 && make update`.
Matthias Schiffer's avatar
Matthias Schiffer committed
23
24
25
26
27
28
29
30

If you're using the autoupdater, do not autoupdate nodes with anything but releases.
If you upgrade using random master commits the nodes *will break* eventually.

## Mailinglist

To subscribe to the list, send a message to:

31
    gluon+subscribe@luebeck.freifunk.net
Matthias Schiffer's avatar
Matthias Schiffer committed
32
33
34
35
36
37

To remove your address from the list, just send a message to
the address in the `List-Unsubscribe` header of any list
message. If you haven't changed addresses since subscribing,
you can also send a message to:

38
    gluon+unsubscribe@luebeck.freifunk.net