ya3

ya3 -- yet another appointment application
Log | Files | Refs

README.rst (1132B)

      1 ya3 -- yet another appointment application
      2 ==========================================
      3 
      4 ya3 wants to be a simple tool helping you to organise your appointments. It is
      5 far away from being finished.
      6 
      7 For licensing information see LICENSE.txt .
      8 
      9 Features
     10 ~~~~~~~~
     11 - Reading all vCal files from a directory and spit out appointments of the next
     12   few days on stdout.
     13 - Creation of new appointments.
     14 
     15 Features to be implemented
     16 ~~~~~~~~~~~~~~~~~~~~~~~~~~
     17 - Support for recurrence (like birthdays).
     18   See https://www.kanzaki.com/docs/ical/rrule.html
     19 - ...
     20 
     21 Requirements
     22 ~~~~~~~~~~~~
     23 - Python3
     24 - virtualenv
     25 
     26 Installation and setup
     27 ~~~~~~~~~~~~~~~~~~~~~~
     28 Get ya3 and place it where you like:
     29 $ cd /path/where/ya3/shall/be/put
     30 $ git pull .... ya3
     31 $ make setup
     32 
     33 Edit configuration in src/config.py to fit your needs.
     34 
     35 Usage
     36 ~~~~~
     37 $ ya3 <command>
     38 
     39 Omit <command> to print a short usage information and available commands.
     40 
     41 Example
     42 ~~~~~~~
     43 You may want to write something like this to your shell's rc file:
     44 ya3 print
     45 
     46 Or to your mailcap(5) file:
     47 text/calendar; /bin/ya3 print -f %s; needsterminal; description=calendar file; nametemplate=%s.ics