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

Wrote readme.

This commit is contained in:
Marcel 2015-01-04 12:21:42 +01:00
parent 4d2c8c74a1
commit 700e77a3ed
1 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -0,0 +1,18 @@
Network Protocol Dictionary
===
This is a YAML network protocol dictionary for all (binary based) OSI-Layer 1-4 protocols, eg. Ethernet, IP, TCP, UDP, etc.
The list may not be complete, if you're missing a protocol, just add it!
How to add a new protocol
----
Clone. Check structure-schema.yml. Install kwalify (has ruby as dependency!). Write protocol file in ./protocols/osi< layer >/< protocolname >.yml. Validate structure with 'kwalify -lf structure-schema.yml < path/to/protocolname >.yml. Be happy.
How to use this dictionary
----
Clone. Get a YAML library for your program language. 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...