Introduce version 0.1
[dueringa_WikiWalker.git] / README.md
blobc1cb6cb7d705e3ace5bb849fd07c2abb606bc27c
1 # WikiWalker
2 Given a wikipedia article, build a graph of article links
4 Input can be any Wikipedia URL. The results can be stored in a JSON cache file.
5 This cache file can be used in successive runs, whereas on each start the
6 cache file is read, combined with the Wikipedia data, and stored again.
8 ## Building
10 Cmake is used as build system. You need curl and boost::program_options.
12 ## Generating graphs with graphviz
14 Since graphs can get very wide, it's recommended to `unflatten` the graph first:
16 ```
17 unflatten -l5 file.dot | dot ...
18 ```
20 Where `5` is the "depth" the links get distributed to.