ppForge
/
NetworkProtocolDictionary
Archived
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

little readme addition

This commit is contained in:
Marcel 2015-02-24 19:53:21 +01:00
parent 8f78c01c21
commit 2cd8460180
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -18,7 +18,7 @@ How to add a new protocol
---- ----
- Clone. - Clone.
- Install ruby+[kwalify](http://www.kuwata-lab.com/kwalify/). - Install ruby+[kwalify](http://www.kuwata-lab.com/kwalify/) (gem install kwalify).
- Check structure-schema.yml. - Check structure-schema.yml.
- Write protocol file in ./protocols/osi[layer]/[protocolname].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'. - 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'.
@ -31,7 +31,7 @@ How to use this dictionary
Currently not recommended, because the project lacks deeper tests than just schema validation. ;) Currently not recommended, because the project lacks deeper tests than just schema validation. ;)
- Clone. - Clone.
- Get a YAML library for your program language. - 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. - Use resulting data structures to build protocol packet structures.