Skip to content
Snippets Groups Projects
README.md 1.43 KiB
Newer Older
  • Learn to ignore specific revisions
  • Matthias Schiffer's avatar
    Matthias Schiffer committed
    Documentation (incomplete at this time, contribute if you can!) may be found at
    
    http://gluon.readthedocs.org/.
    
    Matthias Schiffer's avatar
    Matthias Schiffer committed
    
    If you're new to Gluon and ready to get your feet wet, have a look at the
    [Getting Started Guide](http://gluon.readthedocs.org/en/latest/user/getting_started.html).
    
    **Gluon IRC channel: `#gluon` in [hackint](http://hackint.org/)**
    
    ## Issues & Feature requests
    
    
    Before opening an issue, make sure to check whether any existing issues
    
    Matthias Schiffer's avatar
    Matthias Schiffer committed
    (open or closed) match. If you're suggesting a new feature, drop by on IRC or
    our mailinglist to discuss it first.
    
    
    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
    ## Use a release!
    
    
    Please refrain from using the `master` branch for anything else but development purposes!
    
    Use the most recent release instead. You can list all relaseses by running `git tag`
    
    and switch to one by running `git checkout v2017.1.1 && make update`.
    
    Matthias Schiffer's avatar
    Matthias Schiffer committed
    
    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:
    
    
        gluon+subscribe@luebeck.freifunk.net
    
    Matthias Schiffer's avatar
    Matthias Schiffer committed
    
    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:
    
    
        gluon+unsubscribe@luebeck.freifunk.net