Skip to content

Commit

Permalink
doc update for v0.2 release
Browse files Browse the repository at this point in the history
  • Loading branch information
geier committed Jun 27, 2014
1 parent 9dec57e commit 4fca956
Show file tree
Hide file tree
Showing 5 changed files with 33 additions and 19 deletions.
19 changes: 12 additions & 7 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ About
is achieved by using vdir_/vdirsyncer_ as a backend, `allowing syncing of
calendars with a variety of other programs on a host of different platforms`__.

*khal* is currently in a early stage of development, has a limited feature set
*khal* is currently in an early stage of development, has a limited feature set
and is probably full of bugs. If you do try it out, please make sure you have a
backup of your date and please report back any bugs you might encounter.

Expand Down Expand Up @@ -44,7 +44,8 @@ if it doesn't. You can reach me by email at khal (at) lostpackets (dot) de
Usage
-----

**install**
install
*******

You can install *khal* from source by executing::

Expand All @@ -58,12 +59,14 @@ NetBSD, Debian and Ubuntu with python 2.7.

.. _icalendar: https://github.com/collective/icalendar

**configure**
configure
*********

copy ``khal.conf.sample`` to ``~/.khal/khal.conf`` or
``~/.config/khal/khal.conf`` and edit to your liking.

**syncing**
syncing
*******

To get *khal* working with CalDAV you will first need to setup vdirsyncer_.
After each start *khal* will automatically check if anything has changed and
Expand All @@ -73,7 +76,8 @@ execute *khal* automatically after syncing with vdirsyncer (e.g. via cron).

.. _vdirsyncer: https://github.com/untitaker/vdirsyncer

**basic usage**
basic usage
***********

::

Expand Down Expand Up @@ -104,7 +108,8 @@ See below for usage notes on ikhal.
`khal` can be configured to execute on command (calendar, agenda or interactive)
when no other command is given (see the provided example config).

**quick event adding**
quick event adding
******************

::

Expand Down Expand Up @@ -215,7 +220,7 @@ correct times anyway (and please report back if it doesn't).
Standards Compliance
--------------------
*khal* tries to follow standards and RFCs whereever possible. Known intentional
and unintentional deviations should are listed here:
and unintentional deviations are listed here:


Events with neither END nor DURATION
Expand Down
2 changes: 1 addition & 1 deletion doc/parts/about.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ About
is achieved by using vdir_/vdirsyncer_ as a backend, `allowing syncing of
calendars with a variety of other programs on a host of different platforms`__.

*khal* is currently in a early stage of development, has a limited feature set
*khal* is currently in an early stage of development, has a limited feature set
and is probably full of bugs. If you do try it out, please make sure you have a
backup of your date and please report back any bugs you might encounter.

Expand Down
17 changes: 11 additions & 6 deletions doc/parts/usage.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
Usage
-----

**install**
install
*******

You can install *khal* from source by executing::

Expand All @@ -15,12 +16,14 @@ NetBSD, Debian and Ubuntu with python 2.7.

.. _icalendar: https://github.com/collective/icalendar

**configure**
configure
*********

copy ``khal.conf.sample`` to ``~/.khal/khal.conf`` or
``~/.config/khal/khal.conf`` and edit to your liking.

**syncing**
syncing
*******

To get *khal* working with CalDAV you will first need to setup vdirsyncer_.
After each start *khal* will automatically check if anything has changed and
Expand All @@ -30,7 +33,8 @@ execute *khal* automatically after syncing with vdirsyncer (e.g. via cron).

.. _vdirsyncer: https://github.com/untitaker/vdirsyncer

**basic usage**
basic usage
***********

::

Expand Down Expand Up @@ -61,7 +65,8 @@ See below for usage notes on ikhal.
`khal` can be configured to execute on command (calendar, agenda or interactive)
when no other command is given (see the provided example config).

**quick event adding**
quick event adding
******************

::

Expand Down Expand Up @@ -172,7 +177,7 @@ correct times anyway (and please report back if it doesn't).
Standards Compliance
--------------------
*khal* tries to follow standards and RFCs whereever possible. Known intentional
and unintentional deviations should are listed here:
and unintentional deviations are listed here:


Events with neither END nor DURATION
Expand Down
8 changes: 5 additions & 3 deletions doc/webpage/src/khal02.rst
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
khal v0.2 released
==================
:date: 25.06.2014
:date: 27.06.2014
:category: News
:tags: Releases

A new release of khal is here: `khal v0.2.0`__ (and also available on pypi_
now).
A new release of khal is here: `khal v0.2.0`__ (also available on pypi_).

__ https://lostpackets.de/khal/downloads/khal-0.2.0.tar.gz

If you want to update your installation from pypi_, you can run `sudo pip
install --upgrade khal`.

From now on *khal* relies on vdirsyncer_ for CalDAV sync. While this makes
*khal* a bit more complicated to setup, *vdirsyncer* is much better tested than
*khal* and also the `bus factor`__ increased (at least for parts of the
Expand Down
6 changes: 4 additions & 2 deletions doc/webpage/src/pages/downloads.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,15 @@ Download khal here or from github_ or pypi_
+---------+----------------------------------+------------------------------------------------------------------+
| Version | md5sum | sha256 |
+=========+==================================+==================================================================+
| 0.1.0_ | XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX | XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX |
| 0.2.0_ | df135e484cefd55bc3817a6ab94d7e09 | be9fa1bada0c078805f96fd13d3b9ab44629d775a431ccc04e5ba4947a2a1521 |
+---------+----------------------------------+------------------------------------------------------------------+
| 0.1.1_ | 9c2e96253ddffa43e2a747208959835e | e0a819b01e53d7e75eecc17f7667ef6e42b38be1c526352d7d9d40dddb1b4fc9 |
+---------+----------------------------------+------------------------------------------------------------------+

| 0.1.0_ | XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX | XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX |
+---------+----------------------------------+------------------------------------------------------------------+

.. _github: https://github.com/geier/khal/
.. _pypi: http:/pypi.python.org/pypi/khal/
.. _0.1.0: ../downloads/khal-0.1.0.tar.gz
.. _0.1.1: ../downloads/khal-0.1.1.tar.gz
.. _0.2.0: ../downloads/khal-0.2.0.tar.gz

0 comments on commit 4fca956

Please sign in to comment.