README.md

   1 splanner
   2 ========
   3 splanner is a simple personal planner.
   4
   5 Installation
   6 ------------
   7 ```sh
   8 $ git clone https://github.com/afify/splanner.git
   9 $ cd splanner/
  10 $ make
  11 # make install
  12 ```
  13 Run
  14 ---
  15 ```sh
  16 $ splanner
  17 ```
  18 Options
  19 -------
  20 ```sh
  21 $ splanner [-AaNnv]
  22 $ man splanner
  23 ```
  24 | option | description                                              |
  25 |:------:|:---------------------------------------------------------|
  26 | `-A`   | print all tasks, 12-hour clock format.                   |
  27 | `-a`   | print all tasks.                                         |
  28 | `-N`   | print all upcoming tasks, 12-hour clock format.          |
  29 | `-n`   | print all upcoming tasks.                                |
  30 | `-v`   | print version.                                           |
  31
  32 Configuration
  33 -------------
  34 The configuration of splanner is done by creating a custom config.h
  35 and (re)compiling the source code.
  36
  37 Philosophy & Code Style
  38 -----------------------
  39 - [Philosophy].
  40 - [Code Style].
  41
  42 Copyright and License
  43 ---------------------
  44 splanner is provided under the MIT license.
  45
  46 [Philosophy]: <https://suckless.org/philosophy/>
  47 [Code Style]: <https://suckless.org/coding_style/>