diff --git a/.idea/workspace.xml b/.idea/workspace.xml index 32f7e69..1ea016d 100644 --- a/.idea/workspace.xml +++ b/.idea/workspace.xml @@ -2,14 +2,7 @@ - - - - - - - - + diff --git a/README.md b/README.md index 64c7e4e..4051183 100644 --- a/README.md +++ b/README.md @@ -23,11 +23,17 @@ Simple, isn't it? How to add a new protocol ---- -- Clone. -- Install ruby+[kwalify](http://www.kuwata-lab.com/kwalify/) (gem install kwalify). +Requirements: +- Python 3.5 + - jsonschema + - PyYaml +- (the old kwalify schemas are still present, but deprecated.) + +Howto: +- Clone. - Check structure-schema.yml. -- Write protocol file in ./protocols/osi[layer]/[protocolname].yml. -- Validate structure with 'kwalify -lf structure-schema.yml [path/to/protocolname].yml' or validate all at once with 'kwalify -lf structure-schema.yml ./protocols/osi*/*.yml'. +- Write protocol file in ./protocols/osi[layer]/[protocolname].yml. +- Validate structure with 'python validate.py -f [path/to/protocolname].yml' or all at once with 'python validate.py --all' - Set up a merge request. - Be happy. @@ -36,9 +42,9 @@ How to use this dictionary Currently not recommended, because the project lacks deeper tests than just schema validation. ;) -- Clone. +- Clone. - Get a YAML library for your program language. Or get a converter for JSON or XML, to use these markup languages. -- Load desired protocol files, or all of them. +- Load desired protocol files, or all of them. - Use resulting data structures to build protocol packet structures. This repository will provide examples or useable code snippets for specific programming languages in the future...