[PATCH] INSTALL: explain how to install offlineimap using git

Nicolas Sebrecht nicolas.s-dev at laposte.net
Wed May 4 18:23:02 BST 2011


Signed-off-by: Nicolas Sebrecht <nicolas.s-dev at laposte.net>
---
 docs/INSTALL.rst |   45 ++++++++++++++++++++++++++++++---------------
 1 files changed, 30 insertions(+), 15 deletions(-)

diff --git a/docs/INSTALL.rst b/docs/INSTALL.rst
index bf0fa80..684ca6f 100644
--- a/docs/INSTALL.rst
+++ b/docs/INSTALL.rst
@@ -58,27 +58,42 @@ program.
 System-Wide Installation, Other
 ===============================
 
-Download the tar.gz version of the package from the website.  Then run these
-commands, making sure that you are the "root" user first::
+Check your distribution packaging tool, OfflineIMAP may already be packaged for
+you.
 
-  tar -zxvf offlineimap_x.y.z.tar.gz
-  cd offlineimap-x.y.z
-  python2.2 setup.py install
+System-Wide Installation, From source
+=====================================
 
-On some systems, you will need to use python instead of python2.6.  Next,
-proceed to  below.  You will type offlineimap to invoke the program.
+Get your own copy of the official git repository at `OfflineIMAP`_::
 
-Single-Account Installation
-===========================
+  git clone git://github.com/nicolas33/offlineimap.git
+
+This will download all the sources with history. By default, git set up the
+local master branch up which is most likely what you want. If not, you can
+checkout a particular release::
+
+  cd offlineimap
+  git checkout -b local_version v6.3.3
+
+The latter creates a local branch called "local_version" of the v6.3.3 release.
+
+Then run these commands, to build the python package::
 
-Download the tar.gz version of the package from the website.  Then run these
-commands::
+  make clean
+  make
 
-  tar -zxvf offlineimap_x.y.z.tar.gz
-  cd offlineimap-x.y.z
+Finally, install the program (as root)::
+
+  python setup.py install
+
+Next, proceed to below.  You will type offlineimap to invoke the program.
+
+Single-Account Installation
+===========================
 
-When you want to run `OfflineIMAP`_, you will issue the cd command as above and
-then type `./offlineimap.py`; there is no installation step necessary.
+Download the git repository as described above. Instead of installing the
+program as root, you type `./offlineimap.py`; there is no installation step
+necessary.
 
 =============
 Configuration
-- 
1.7.5.278.g5fde9





More information about the OfflineIMAP-project mailing list