Commit ce7e5510 authored by Sriram Karra's avatar Sriram Karra

Update docs and reduce number of places intro needs to be edited

still not found a way to get the intro.texi stuff into the
README file... But oh, well. something is better than nothing.
parent ee0cb4ed
......@@ -21,3 +21,12 @@ login.auth
state.json
logs
backups
# Doc related stuff.
*.html
*.info
*.pdf
*.dvi
asynk.xml
asynk.txt
Created : Wed Aug 24 22:41:42 IST 2011
Last Modified : Tue May 15 09:47:27 IST 2012
- Created : Wed Aug 24 22:41:42 IST 2011
- Last Modified : Thu May 17 13:15:27 IST 2012
This is only a short introduction and some key points of interest. For more
details on how to use ASynK please refer to the included documentation, or the
......@@ -13,26 +13,27 @@ that website.
written in Python. ASynK was earlier known as Gout. High level features
include:
- ASynK allows bidirectional sync of Contact across any pair of sources
from: Google Contacts, Microsoft Outlook, and Emacs BBDB - what we call
PIM DBs (for Personal Information Management Databases)
- ASynK is the only two-way synchronization software for BBDB known to be in
existence today. So if you are keen to keep BBDB content synchronized with
a mobile device or Outlook, look no further.
- ASynK works on Windows, MacOS X, and Linux
- ASynK allows two-way sync of Contacts across any two support sources -
Google Contacts, Microsoft Outlook, and Emacs BBDB.
- ASynK is the only two-way synchronization option for BBDB known to be in
existence today. So if you are keen to keep your BBDB content synchronized
with a mobile device or Outlook, look no further.
- ASynK works on Windows, MacOS X, and Linux. Outlook synchronization
only works on Windows.
- Synchronization is granular to the level of 'Folders', i.e. you can
synchronize one folder of Google Contacts with a Outlook folder (on
Windows at work, say), and another Google folder in the same account with
BBDB (On your Mac, say)
- The infrastructure is there to add more database and item types
(i.e. tasks, notes, etc.), but currently only Contact synchronization for
(i.e. tasks, notes, etc.), but currently only Contacts synchronization for
Google Contacts, BBDB and Outlook supported
- It is free software, and released under the GNU AGPL version 3
- It is free software, and released under the GNU AGPL (Affero GPL) version
3
* Installation
......@@ -48,25 +49,24 @@ that website.
- On Debian (and likely Ubuntu) you will need the following packages:
sudo apt-get install python-argparse
** Building Documentation
There is no build or installation required to use the main program. You can
go the section on Usage below.
go the section on Usage in the documentation
If you wish to build the documentation from source, you can try one of the
following:
If you wish to build the documentation from source, you will have to
execute the following commands in order from the root directory, i.e where
you have the configure.ac file
- $ cd doc
- $ make pdf
- $ make # Builds all the targets
- $ make clean
- $ make distclean
- $ autoreconf
- $ automake --add-missing
- $ ./configure
- $ make
The supported doc types are: 'pdf', 'html', 'info', 'docbook', and 'text'
You may have to install additional programs like makeinfo and other TeX
related programs.
You will need autoconf (>2.64), automake (> 1.11) for the above to work.
You may have to install additional programs like makeinfo, texi2html
etc. See the "Depdencies" section in the documentation
** Usage
......
#!/bin/bash
sed s/'@enumerate'/'<ol>'/g | sed s/'@item'/'<li>'/g | sed s/'@end enumerate'/'<\/ol>'/g
@enumerate
@item
ASynK allows two-way sync of Contacts across any two support sources - Google
Contacts, Microsoft Outlook, and Emacs BBDB.
@item
ASynK is the only two-way synchronization option for BBDB known to be in
existence today. So if you are keen to keep your BBDB content synchronized
with a mobile device or Outlook, look no further.
@item
ASynK works on Windows, MacOS X, and Linux. Outlook synchronization
only works on Windows.
@item
Synchronization is granular to the level of 'Folders', i.e. you can
synchronize one folder of Google Contacts with a Outlook folder (on Windows at
work, say), and another Google folder in the same account with BBDB (On your
Mac, say)
@item
The infrastructure is there to add more database and item types (i.e. tasks,
notes, etc.), but currently only Contacts synchronization for Google Contacts,
BBDB and Outlook supported
@item
It is free software, and released under the GNU AGPL (Affero GPL)
version 3
@end enumerate
##
## Created : Sat May 12 11:31:29 IST 2012
## Last Modified : Sat May 12 11:31:34 IST 2012
## Last Modified : Thu May 17 11:50:42 IST 2012
##
## Copyright (C) 2012 by Sriram Karra <karra.etc@gmail.com>
##
......@@ -27,13 +27,13 @@ from google.appengine.ext.webapp.util import run_wsgi_app
class MainPage(webapp.RequestHandler):
def get(self):
home_greeting = self.request.get('result')
if home_greeting == '':
home_greeting = "There will be something here someday"
intro = ''
path = os.path.join(os.path.dirname(__file__), 'intro.html')
with open(path, 'r') as f:
intro = f.read()
template_values = {
'home_greeting': home_greeting,
'intro_html': intro,
}
path = os.path.join(os.path.dirname(__file__), 'index.html')
......
<!--
// Created : Sat May 05 13:15:20 IST 2012
// Last Modified : Tue May 15 14:35:59 IST 2012
// Last Modified : Thu May 17 12:05:12 IST 2012
//
// Copyright (C) 2012, Sriram Karra <karra.etc@gmail.com>
// All Rights Reserved
......@@ -80,33 +80,8 @@
<p>Some of the key features of ASynK are:
<ol type=1 start=1>
{{ intro_html }}
<li>Allows bidirectional sync of Contacts across any pair of
sources from: Google Contacts, Microsoft Outlook, and Emacs BBDB
- what we call PIM DBs (for Personal Information Management
Databases)</li>
<li> ASynK is the <u>only</u> two-way synchronization software for
BBDB known to work today. So if you are keen to keep your BBDB
content synchronized with a mobile device or Outlook, look no
further. </li>
<li>Works on Windows, MacOS X, and Linux. Outlook synchronization
only works on Windows.</li>
<li>Synchronization is granular to the level of 'Folders', i.e. you can
synchronize one folder of Google Contacts with a Outlook folder (on
Windows at work, say), and another Google folder in the same account with
BBDB (On your Mac, say)</li>
<li>The infrastructure is there to add more database and item types
(i.e. tasks, notes, etc.), but currently only Contact synchronization for
Google Contacts, BBDB and Outlook supported</li>
<li>It is free software, and released under the GNU AGPL (Affero GPL)
version 3 </li>
</ol>
</div>
<div id="announce_text" class="section" style="display:none">
......@@ -128,15 +103,15 @@
<h3>Download Pre-packaged Bundles</h3>
Bundles are available in the following formats.
<ul>
<li>The latest stable release: v0.2.0
<li>The latest stable release: v0.2.1
<ul>
<li> <a
href="https://github.com/downloads/skarra/ASynK/asynk-v0.2.0.tar.gz">
href="https://github.com/downloads/skarra/ASynK/asynk-v0.2.1.tar.gz">
Gzipped tar archive</a>
</li>
<li> <a
href="https://github.com/downloads/skarra/ASynK/asynk-v0.2.0.zip">
href="https://github.com/downloads/skarra/ASynK/asynk-v0.2.1.zip">
Zip File </a>
</li>
</ul>
......@@ -145,6 +120,16 @@
<li>
Earlier releases:
<ul>
<li> <a
href="https://github.com/downloads/skarra/ASynK/asynk-v0.2.0.tar.gz">
Gzipped tar archive</a>
</li>
<li> <a
href="https://github.com/downloads/skarra/ASynK/asynk-v0.2.0.zip">
Zip File </a>
</li>
<li> <a
href="https://github.com/downloads/skarra/ASynK/gout-v0.1.0.zip">
v0.1.0.zip </a>
......@@ -179,12 +164,13 @@
and use with Emacs Info documentation reading system
</li>
<li>
<a href='javascript:window.open("/doc/asynk.html")'>HTML for
<a href='javascript:window.open("/doc/asynk/asynk.html")'>HTML for
online browing</a>, single html page (will open new window)
</li>
<li>
<a href='doc/asynk.texi'>The source Texinfo file</a>. You can
also find this file in the source tree in doc/ directory.
<a href='doc/asynk.texi'>The main source Texinfo file</a>. You
can find this file along with the associated texi files in
the doc/ directory of the source tree.
</li>
</ul>
</p>
......@@ -247,7 +233,7 @@
<p/>
<div id="footer_content">
Copyright &copy; 2012 Sriram Karra (karra.etc at gmail dot com)<br/>
Last Modified: Mon May 14 22:47:49 IST 2012
Last Modified: Thu May 17 12:03:22 IST 2012
</footer>
</body>
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment