adding a README

This commit is contained in:
Vincent Batts 2012-08-06 14:49:56 -04:00
parent 3e9789880d
commit 168d256fea

28
README.md Normal file
View file

@ -0,0 +1,28 @@
== Overview
POC to compile a data set into a modified radix tree,
and applying huffman encoding.
== Usage
Take in an v1 x509 certificate, and extract the
content sets, output them to newline delimited output
$> ruby ./thing.rb d this-cert.pem > this-cert.list
Process this output to generate the compiled output
$> ruby ./thing.rb c this-cert.list
This would produce a file named 'this-cert.bin'
Then, the unpack the binary with:
$> ./unpack this-cert.bin
== Code compiles
To compile the 'unpack' command, just run `make`.
( this requires make, gcc, and zlib-devel)