diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..46e2483 --- /dev/null +++ b/README.md @@ -0,0 +1,17 @@ +# PeriJect: A git-backed task management system + +Data is stored through a folder hierarchy in yaml data files. Data can be +edited by hand and validated using the provided schema files or tools can be +developed to aid the creation and manipulation of the data sources. + +## Project Dependancies: + + - pykwalify: + + Documentation: https://pykwalify.readthedocs.io/ + Installation: pip3 install pykwalify + + Custom validation is possible with pykwalify which may assist with complex + use cases in the future. See: + + - https://pykwalify.readthedocs.io/en/unstable/extensions.html#how-custom-validation-works |