From d8bb316a5786f29a7daf62e1a61435b72ba3d0d2 Mon Sep 17 00:00:00 2001 From: Patrick Uven Date: Sun, 12 Oct 2014 12:17:02 +0200 Subject: [PATCH] Added informations about gluon versions to getting started --- docs/user/getting_started.rst | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/docs/user/getting_started.rst b/docs/user/getting_started.rst index 606e650c..d62f7dd7 100644 --- a/docs/user/getting_started.rst +++ b/docs/user/getting_started.rst @@ -1,6 +1,22 @@ Getting Started =============== +Selecting the right version +--------------------------- + +The versions of gluon are managed with tags and branches. Every tag is a stable release (like v2014.2 or v2014.3.1), every branch is a development branch, where 2014.3.x is a branch for 2014.3 bugfix releases and master is the unstable branch for the upcoming release. Branches should be used for development purposes, while tags can be used for productive releases. To check out a branch do: + +:: + + git clone https://github.com/freifunk-gluon/gluon.git gluon + cd gluon + git checkout v2014.3 + +Please keep in mind that you need the appropriate site configuration for that gluon version. + +Building the image +------------------ + To build Gluon, after checking out the repository change to the source root directory to perform the following commands: