From e7439b5d774e62a9477f67ad3d3bc2bb3c3a5657 Mon Sep 17 00:00:00 2001 From: Nicolas Sebrecht Date: Sat, 7 May 2011 14:37:23 +0200 Subject: [PATCH] doc: introduce a new HACKING file This aims to help newcomers to be very fast to involve into the project. Signed-off-by: Nicolas Sebrecht --- docs/HACKING.rst | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) 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:: + +=================== +HACKING OFFLINEIMAP +=================== + +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 +=== + +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 +appreciated.