From bffecd20205b204b70272a76854b2a96a0341189 Mon Sep 17 00:00:00 2001 From: Marco Biasini <marco.biasini@unibas.ch> Date: Fri, 25 Feb 2011 11:45:49 +0100 Subject: [PATCH] added blurps about "picking the right branch" and "updating the source code" to installation instructions --- modules/doc/install.rst | 22 +++++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-) diff --git a/modules/doc/install.rst b/modules/doc/install.rst index 525561543..ff56c8abe 100644 --- a/modules/doc/install.rst +++ b/modules/doc/install.rst @@ -71,6 +71,16 @@ OpenStructure uses `git` as the revision control system. The main repository can The above command will clone OpenStructre into the directory called `directory-name`. If omitted, the directory will be called ost. Alternatively, you might consider getting one of the nightly source code snapshots from the `downloads section <http://www.openstructure.org/downloads/>`_. +Picking the right branch +-------------------------------------------------------------------------------- + +By default you are checking out the master branch. Master is, by definition a stable branch. It always points to the latest release. However, there are several other branches at your disposal. The main development is happening in the develop branch. It contains the newest features and bug fixes. However, we dont't make any guarantees that the develop branch is bug free and doesn't contain major bugs. After all, it's in constant flux. If you are developing new features, start your feature branch off develop. Besides that, there are several smaller features branches that are used to group together commits for one specific features. To change to a specific branch, use + +.. code-block:: bash + + git checkout <branch-name> + + Configuring -------------------------------------------------------------------------------- @@ -162,7 +172,6 @@ run multiple jobs at once. On Windows run 'Build OpenStructure' from the build menu. - What's next? -------------------------------------------------------------------------------- @@ -179,3 +188,14 @@ or, to start the command-line interpreter: stage/bin/ost If you repeatedly use OpenStructure, it is recommended to add /path/to/dng/stage/bin to your path. + +Getting the newest changes +-------------------------------------------------------------------------------- + +To get the newest changes from the central git repository, enter + +.. code-block:: bash + + git pull + +in your terminal. This will fetch the newest changes. -- GitLab