Skip to content

Commit

Permalink
Changes on the README and fix on a doc image
Browse files Browse the repository at this point in the history
  • Loading branch information
Roberto committed May 14, 2018
1 parent 96927ef commit 7715f47
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 8 deletions.
25 changes: 17 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,24 +4,34 @@ Item dependency visualization tool, based on [Graphviz](https://www.graphviz.org
## Full description
Tool that allows a graphical visualization of dependencies between items (i.g. nodes on a directed graph) using [Graphviz](https://www.graphviz.org/), without the need of using the [Dot language](https://www.graphviz.org/doc/info/lang.html).

**TFS:** ![Configure TFS](images/tfs_example1.png)
**CSV:** ![Configure TFS](images/csv_example1.png)

## How it does it?
The tool uses different (currently **TFS** and **CSV**) repositories in order to obtain the **Items** (nodes), its **Successors**, **States** and **Tags**.

* **Items**: the "box" with its ID and Title.
* **Succesors**: the successor (connected with an arrow) "box"
* **States**: possible states (the default are the TFS ones: _New_, _Approved_, _Committed_, _In Progress_ and _Done_. These are used to color the "box"
* **Tags**: item tags. These are used to change the shape/line of the "box"
* **Tags**: item tags. These are used to change the line/color of the line "box"

# Getting Started

## Prerequisites
* Windows 7 or 10
* Install [Graphviz](https://graphviz.gitlab.io/download/)
* Annotate the binaries installation path (i.g. C:\Program Files (x86)\Graphviz2.38\bin)

# Setup
## Installation
:information_source: _At some point I will create an installer_
:construction: _At some point I will create an installer_

Download the binaries (or build the tool yourself)

## Configuration
1. Enter the GraphViz path you annotated above on the **appSettings.graphvizPath** tag, on the **depviz.exe.config** file.
1. Depending on the repository/connector you will use (TFS, CSV, ...), follow the instructions below:

### TFS

## TFS
1. Open the tool
1. File -> Select Connector... -> TFS
1. Configure TFS: ![Configure TFS](images/tfs_config.png)
Expand All @@ -30,11 +40,10 @@ Download the binaries (or build the tool yourself)

:information_source: You can also achieve this by editing the **userSettings.tfsUrl** tag, on the **depviz.exe.config** file, before opening **depviz.exe**

### CSV

## CSV
1. Open the tool
1. File -> Select Connector... -> CSV
1. Select CSV file: ![Select CSV file](images/csv_config.png)


# Add support for other repositories
:construction: _You could write your own "connector" (and connect the tool with [Jira](https://www.atlassian.com/software/jira), for example). There will be a wiki soon explaining this._
Binary file modified images/tfs_config.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 7715f47

Please sign in to comment.