search

pulb / mailnag

An extensible mail notification daemon
GNU General Public License v2.0
254 stars 32 forks source link

Documentation? #170

Open doronbehar opened 6 years ago

doronbehar commented 6 years ago

I would like to create a systray app for mailnag that will be compatible with more desktop environments. From what I understand, the way to talk to mailnag is through it's dbus interface, right? I installed d-feet and I saw that mailnag has these methods and signals:

mailnag dbus api

I think it'll be proper to document these thoroughly somewhere in this repo, perhaps in the WiKi.

tikank commented 6 years ago

Excellent! For this kind of documentation I would suggest creating docs/dbus-interface.txt (or .md, or something like that) in the source tree, so that it could be versioned with the software.

pulb commented 6 years ago

@doronbehar: a systray app is a very welcome idea! Unfortunately I currently don't have time to work on Mailnag let alone on documentation. Though i'd be glad to answer any question regarding the dbus API or Mailnag in general.

doronbehar commented 6 years ago

Once I'll actually start developing this systray app I'll try to write documentation afterwards.