Permalink
Browse files

Added minimal documentation.

  • Loading branch information...
1 parent d84d411 commit d8405f4066dae3a6e1580ae271987014e9717227 Michele Spagnuolo committed Mar 31, 2014
Showing with 15 additions and 0 deletions.
  1. +15 −0 DOCS
View
@@ -0,0 +1,15 @@
+This document is a minimal quickstart tutorial to use BitIodine and is in no way comprehensive or complete.
+
+1) Make sure the bitcoind (>= 0.8.6) blockchain is up to date in ~/.bitcoin
+
+2) Go to blockparser, type "make" to compile the BlockParser
+
+3) Run "./parser sql" to generate (or incrementally update) the SQLite database of the blockchain
+
+4) To generate clusters, go to clusterizer/ and run "./clusterizer.py --generate-clusters". To generate a CSV file, after generating clusters run "./clusterizer.py --csv"
+
+5) To generate the NetworkX transaction graph (and user graph) or the LEMON transaction graph, you can use the Python scripts in grapher/
+
+6) After generating clusters and the NetworkX transaction graph, you can use the Classifier in "classifier/"
+
+6) To run the C++ server, compile ("make") and run "./bitiodine_server" in lemon/

0 comments on commit d8405f4

Please sign in to comment.