[PATCH 1/2] doc: introduce a new HACKING file

Nicolas Sebrecht nicolas.s-dev at laposte.net
Sun May 8 16:19:18 BST 2011

This aims to help newcomers to be very fast to involve into the project.

Signed-off-by: Nicolas Sebrecht <nicolas.s-dev at laposte.net>
 docs/HACKING.rst |   23 +++++++++++++++++++++++
 1 files changed, 23 insertions(+), 0 deletions(-)
 create mode 100644 docs/HACKING.rst

diff --git a/docs/HACKING.rst b/docs/HACKING.rst
new file mode 100644
index 0000000..623583f
--- /dev/null
+++ b/docs/HACKING.rst
@@ -0,0 +1,23 @@
+.. -*- coding: utf-8 -*-
+.. _OfflineIMAP: https://github.com/nicolas33/offlineimap
+.. contents::
+.. sectnum::
+Welcome to the `OfflineIMAP`_ project. You'll find here all the information you
+need to start hacking OfflineIMAP. Be aware there are a lot of very usefull tips
+in the mailing list.  You may want to subscribe if you didn't, yet. This is
+where you'll get help.
+API is documented in the dev-doc-src directory using the sphinx tools (also used
+for python itself). This is a WIP. Contributions in this area would be very

More information about the OfflineIMAP-project mailing list