mirror of
https://github.com/GothenburgBitFactory/timewarrior.git
synced 2025-07-27 12:16:25 +02:00
Common: Added README identifying rules
This commit is contained in:
parent
01f6c8daad
commit
94248e57ea
1 changed files with 16 additions and 0 deletions
16
src/common/README
Normal file
16
src/common/README
Normal 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.
|
||||
|
Loading…
Add table
Add a link
Reference in a new issue