Common: Added README identifying rules

This commit is contained in:
Paul Beckingham 2015-12-20 09:59:04 -05:00
parent 01f6c8daad
commit 94248e57ea

16
src/common/README Normal file
View file

@ -0,0 +1,16 @@
Common
======
The 'common' library is a set of reusable objects to be shared as-is between
various programs, including Taskwarrior, Taskserver, Tasksh and Timewarrior.
In order to be reusable, and therefore a member of libcommon, rules must be
followed:
- Common objects may only make use of other common objects, or external
dependencies (libuuid, gettext, readline etc), but no objects from the
parent directories.
- Common objects can assume only an external 'cmake.h' that defines
platform/portability constants.