OSDN Git Service

add README.md
[ti2/ti2.git] / README.md
1 #ti2
2 `ti2` is a tool to generate a network diagram in the OS(Linux)
3 from os environment.
4
5 ##Features
6 * Collect the network information for the OS (Open vSwitch, Linux Bridge, libvirt)
7 * Generate the input format of Graph-Easy (basic feature).
8   Graph-Easy http://search.cpan.org/~shlomif/Graph-Easy-0.72/lib/Graph/Easy.pm
9 * Generate the springy HTML format.
10   Springy https://github.com/dhotson/springy
11
12 ##Setup
13
14 ###by tar ball
15 Extract the tar file::
16
17    $ tar xfz ti2-x.x.tar.gz
18
19 ###use
20    $ cd ti2-x.x
21    $ ./ti2.py
22
23 ##Requirements
24 * Python 2.6 or later
25 * Python Libvirt Library 0.9.10 or later.
26 * Python Flask Library 0.10.1 or later.
27 * Python SSH Library 1.8.0 or later. (or Paramiko Library 1.7.5 or later.)
28
29
30 ##License
31 Apache License 2.0
32
33
34 ##History
35 1.2 (2013-10-14)
36 ------------------
37 * public release
38
39 1.1 (2013-03-06)
40 ------------------
41 * first release
42