commit 94154a9fb7d2c402ad24b4064b03667093ce3aae
parent aa97153dc29fcae42301166c78d390161ccde330
Author: Jaromil <jaromil@dyne.org>
Date: Sat, 14 Sep 2013 13:24:15 +0200
release documentation
Diffstat:
| D | ChangeLog | | | 57 | --------------------------------------------------------- |
| A | ChangeLog.txt | | | 69 | +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ |
| D | README | | | 102 | ------------------------------------------------------------------------------- |
| A | README.txt | | | 150 | +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ |
4 files changed, 219 insertions(+), 159 deletions(-)
diff --git a/ChangeLog b/ChangeLog
@@ -1,57 +0,0 @@
-Jaro Mail 1.1 - 18 October 2012 - Slick bastard
-
- Lots of bugfixes, code cleanups and usability improvements are
- paving the way for some new powerful features.
-
- The addressbook system has been enhanced to permit editing of the
- entries in white and blacklist, plus import and export of VCards
- is now possible.
-
- The use of GnuPG in Mutt is fixed, along with performance
- and usability improvements also to search.
-
- Vim is now used as default editor, configured to properly format
- emails with paragraph justification.
-
- More improvements were done also to the management of multiple
- accounts, mailbox filtering, maildir merge and backup.
-
-Jaro Mail 1.0 - 18 June 2012 - E-Data addict
-
- Software development went forward in a rather passionate way,
- mostly motivated by the author's need to backup his rather big
- archive of e-mails. So this release's focus is on stability,
- search and backup features and a rather deep refactoring of the
- codebase.
-
- Mairix has been added as an integrated search engine.
-
- Backup is possible also using search expressions (see manual)
-
- Some new modules in statistics implement jquery reports.
-
- Code is modularized in pre-compiled zsh modules.
-
- Extensive testing has proven the whole setup to be stable and
- ready for production use, hence the 1.0 release.
-
-Jaro Mail 0.9 - 06 May 2012 - The rush of the unemployed
-
- After getting recently unemployed because of European austerity
- cuts (and because of not working in a bank), Jaromil followed up
- with a full pijama coding session that lasted about a week,
- hammering out most issues that make now this software enter BETA
- stage, while starting to use it for real.
-
- This is the first public release of Jaro Mail, it comes with a
- User Manual and lots of usability fixes over the previous, it was
- tested on GNU and OSX operating systems.
-
-
-Jaro Mail 0.1 - 29 May 2012 - Initial release
-
- After a dozen years of development and use, Jaromil releases his
- own e-mail and mailinglist desktop setup.
-
- While doing so, J. asked his friend and PhD colleague Max
- Kazemzadeh how he should call it, and Max replied: Jaro Mail! :^D
diff --git a/ChangeLog.txt b/ChangeLog.txt
@@ -0,0 +1,69 @@
+Jaro Mail 1.2 - 14 September 2012
+ Several usability improvements and bugfixes both for usage on
+ GNU/Linux and Apple/OSX systems. The latter has now a different
+ distribution format for JaroMail as a self-contained app bundle.
+
+ Bugfixes for: backup mechanism, gnupg wrapper, file attachments,
+ whitelisting, HTML mail rendering.
+
+ New features include a native keyring mechanism to store account
+ informations in a single-pass symmetric encrypted file.
+ Minor updates to the documentation.
+
+Jaro Mail 1.1 - 18 October 2012 - Slick bastard
+
+ Lots of bugfixes, code cleanups and usability improvements are
+ paving the way for some new powerful features.
+
+ The addressbook system has been enhanced to permit editing of the
+ entries in white and blacklist, plus import and export of VCards
+ is now possible.
+
+ The use of GnuPG in Mutt is fixed, along with performance
+ and usability improvements also to search.
+
+ Vim is now used as default editor, configured to properly format
+ emails with paragraph justification.
+
+ More improvements were done also to the management of multiple
+ accounts, mailbox filtering, maildir merge and backup.
+
+Jaro Mail 1.0 - 18 June 2012 - E-Data addict
+
+ Software development went forward in a rather passionate way,
+ mostly motivated by the author's need to backup his rather big
+ archive of e-mails. So this release's focus is on stability,
+ search and backup features and a rather deep refactoring of the
+ codebase.
+
+ Mairix has been added as an integrated search engine.
+
+ Backup is possible also using search expressions (see manual)
+
+ Some new modules in statistics implement jquery reports.
+
+ Code is modularized in pre-compiled zsh modules.
+
+ Extensive testing has proven the whole setup to be stable and
+ ready for production use, hence the 1.0 release.
+
+Jaro Mail 0.9 - 06 May 2012 - The rush of the unemployed
+
+ After getting recently unemployed because of European austerity
+ cuts (and because of not working in a bank), Jaromil followed up
+ with a full pijama coding session that lasted about a week,
+ hammering out most issues that make now this software enter BETA
+ stage, while starting to use it for real.
+
+ This is the first public release of Jaro Mail, it comes with a
+ User Manual and lots of usability fixes over the previous, it was
+ tested on GNU and OSX operating systems.
+
+
+Jaro Mail 0.1 - 29 May 2012 - Initial release
+
+ After a dozen years of development and use, Jaromil releases his
+ own e-mail and mailinglist desktop setup.
+
+ While doing so, J. asked his friend and PhD colleague Max
+ Kazemzadeh how he should call it, and Max replied: Jaro Mail! :^D
diff --git a/README b/README
@@ -1,102 +0,0 @@
-
- oo oo dP
- 88
- dP .d8888b. 88d888b. .d8888b. 88d8b.d8b. .d8888b. dP 88
- 88 88' `88 88' `88 88' `88 88'`88'`88 88' `88 88 88
- 88 88. .88 88 88. .88 88 88 88 88. .88 88 88
- 88 `88888P8 dP `88888P' dP dP dP `88888P8 dP dP
- 88~ooooooooooooooooooooooooooooooooooooooooooooooooooooo
- odP your humble and faithful electronic postman v 1.1
-
-A commandline tool to easily and privately handle your e-mail
-
-Homepage with more information and links to the manual:
-
- http://jaromail.dyne.org
-
-
-
-* INSTALL
-
-Use the install script.
-
-It will check for all requirements on your system to be satisfied.
-
-Give it a path as argument if you want to install your Jaro Mail
-directory into something different than Mail inside your Home.
-
-./install.sh $HOME/Mail
-
-will install Jaro Mail in a Mail folder in your $HOME
-
-Jaro Mail is completely reentrant: if you install it in multiple
-locations you can have completely separated setups, with multiple
-identities and different filters.
-
-* USAGE instructions
-
-See the commandline help:
-
- jaro -h
-
-and make sure to read the manual: it contains a lot of useful tips!
-
-
-
-* BUILD (not necessary for OSX binary packages)
-
-Use the build scripts in build/
-
-You will need a compiler installed (XCode on Apple/OSX)
-
-But if you use Apple/OSX you can simply download the binary.
-
-If you are building then, first enter the build subdir
-
-cd build
-./build-gnu.sh (or osx)
-
-A Manual is in the works
-
-
-
-* DEVELOPERS
-
-All revisioned in Git, see http://code.dyne.org/jaromail
-
-To clone anonymously use
-
- git clone git://code.dyne.org/jaromail.git
-
-Patches welcome.
-
-Come on channel #dyne on http://hinezumi.im to get in touch with devs
-
-
-
-* DONATE
-
-Money donations are very welcome and well needed, they will encourage
-further development even beyond my own needs for this software.
-
- http://dyne.org/donate
-
-
-
-* LICENSE
-
-# Copyleft (C) 2010-2012 Denis Roio <jaromil@dyne.org>
-#
-# This source code is free software; you can redistribute it and/or
-# modify it under the terms of the GNU Public License as published by
-# the Free Software Foundation; either version 3 of the License, or
-# (at your option) any later version.
-#
-# This source code is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
-# Please refer to the GNU Public License for more details.
-#
-# You should have received a copy of the GNU Public License along with
-# this source code; if not, write to:
-# Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
diff --git a/README.txt b/README.txt
@@ -0,0 +1,150 @@
+
+ oo oo dP
+ 88
+ dP .d8888b. 88d888b. .d8888b. 88d8b.d8b. .d8888b. dP 88
+ 88 88' `88 88' `88 88' `88 88'`88'`88 88' `88 88 88
+ 88 88. .88 88 88. .88 88 88 88 88. .88 88 88
+ 88 `88888P8 dP `88888P' dP dP dP `88888P8 dP dP
+ 88~ooooooooooooooooooooooooooooooooooooooooooooooooooooo
+ odP your humble and faithful electronic postman v 1.2
+
+A commandline tool to easily and privately handle your e-mail
+
+Homepage with more information and links to the manual:
+
+ http://jaromail.dyne.org
+
+
+
+* INSTALL
+
+Apple/OSX users can simply drag JaroMail into /Applications
+
+Nevertheless, you need to read the Manual: this software is not
+graphical, yes has a high productive potential. JaroMail is operated via
+Terminal, configured in plain text and overall made by geeks for geeks.
+Beware.
+
+GNU/Linux users can use the build/build-gnu.sh script to install
+dependencies and build all necessary binaries. This is still dirty, it
+will likely never be really packaged by zealots into their distros, but
+works well for those who use it. It might get better in some future.
+After build, use the ./install.sh script to put JaroMail in $HOME/Mail
+or use an argument to install it in some other location.
+
+
+Jaro Mail is completely reentrant: if you install it in multiple
+locations you can have completely separated setups, with multiple
+identities and different filters.
+
+* USAGE instructions
+
+See the commandline help:
+
+ jaro -h
+
+When in doubt, make sure you read the User's Manual, it is important.
+
+
+
+* DEVELOPERS
+
+All revisioned in Git, see https://github.com/dyne/JaroMail
+
+Pull requests and patches welcome.
+
+Come on channel #dyne on https://irc.dyne.org to get in touch with devs
+
+Make sure to idle in that channel, answers take some time to come.
+
+We are all idling artists.
+
+
+* DONATE
+
+Money donations are very welcome and well needed, they will encourage
+further development even beyond my own needs for this software.
+
+ https://dyne.org/donate
+
+
+
+* ACKNOWLEDGEMENTS
+
+JaroMail is conceived, designed and put together with a substantial
+amount of ZShell scripts and some C code by Jaromil @ Dyne.org
+
+The Mutt sourcecode included is maintained by Antonio Radici
+<antonio@dyne.org> who is also the original maintainer of the Debian
+package. Here below the list of main Mutt authors:
+Mutt is
+ Copyright (C) 1996-2007 Michael R. Elkins <me@cs.hmc.edu>
+ Copyright (C) 1996-2002 Brandon Long <blong@fiction.net>
+ Copyright (C) 1997-2008 Thomas Roessler <roessler@does-not-exist.org>
+ Copyright (C) 1998-2005 Werner Koch <wk@isil.d.shuttle.de>
+ Copyright (C) 1999-2009 Brendan Cully <brendan@kublai.com>
+ Copyright (C) 1999-2002 Tommi Komulainen <Tommi.Komulainen@iki.fi>
+ Copyright (C) 2000-2004 Edmund Grimley Evans <edmundo@rano.org>
+ Copyright (C) 2006-2008 Rocco Rutte <pdmef@gmx.net>
+
+Mairix, the search engine we use in Jaro Mail, is licensed GNU GPL v2
+Mairix is
+ Copyright (C) Richard P. Curnow 2002,2003,2004,2005,2006,2007,2008
+ Copyright (C) Sanjoy Mahajan 2005
+ Copyright (C) James Cameron 2005
+ Copyright (C) Paul Fox 2006
+And received contributions from: Anand Kumria André Costa, Andreas
+Amann, Andre Costa, Aredridel, Balázs Szabó, Bardur Arantsson,
+Benj. Mako Hill, Chris Mason, Christoph Dworzak, Christopher Rosado,
+Chung-chieh Shan, Claus Alboege, Corrin Lakeland, Dan Egnor, Daniel
+Jacobowitz, Dirk Huebner, Ed Blackman, Emil Sit, Felipe Gustavo de
+Almeida, Ico Doornekamp, Jaime Velasco Juan, James Leifer, Jerry
+Jorgenson, Joerg Desch, Johannes Schindelin, Johannes Weißl, John
+Arthur Kane, John Keener, Jonathan Kamens, Josh Purinton, Karsten
+Petersen, Kevin Rosenberg, Mark Hills, Martin Danielsson, Matthias
+Teege, Mikael Ylikoski, Mika Fischer, Oliver Braun, Paramjit Oberoi,
+Paul Fox, Peter Chines, Peter Jeremy, Robert Hofer, Roberto Boati,
+Samuel Tardieu, Sanjoy Mahajan, Satyaki Das, Steven Lumos, Tim Harder,
+Tom Doherty, Vincent Lefevre, Vladimir V. Kisil, Will Yardley,
+Wolfgang Weisselberg.
+
+Procmail was originally designed and developed by Stephen R. van den
+Berg. The Procmail library collection included in Jaro Mail is developed
+and maintained by Jari Aalto.
+
+MSmtp is developed and maintained by Martin Lambers.
+
+The RFC 822 address parser (fetchaddr) is originally written by
+Michael Elkins for the Mutt MUA.
+
+The gateway to Apple/OSX addressbook (ABQuery) was written by Brendan
+Cully and just slightly updated for our distribution.
+
+We are also including some (experimental, still) modules for statistical
+visualization using JQuery libraries:
+
+Timecloud is Copyright (C) 2008-2009 by Stefan Marsiske
+TagCloud version 1.1.2 (c) 2006 Lyo Kato <lyo.kato@gmail.com>
+ExCanvas is Copyright 2006 Google Inc.
+jQuery project is distributed by the JQuery Foundation under the
+ terms of either the GNU General Public License (GPL) Version 2.
+The Sizzle selector engine is held by the Dojo Foundation and is
+ licensed under the MIT, GPL, and BSD licenses.
+JQuery.sparkline 2.0 is licensed under the New BSD License
+Visualize.JQuery is written by Scott Jehl Copyright (c) 2009 Filament Group
+
+# JaroMail is Copyright (C) 2010-2013 Denis Roio <jaromil@dyne.org>
+#
+# This source code is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Public License as published by
+# the Free Software Foundation; either version 3 of the License, or
+# (at your option) any later version.
+#
+# This source code is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+# Please refer to the GNU Public License for more details.
+#
+# You should have received a copy of the GNU Public License along with
+# this source code; if not, write to:
+# Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
