Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
cezarypiatek committed Nov 5, 2016
2 parents 39f6706 + 5d4651d commit 4b8c685
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,18 @@
# CodeTopology
A tool to visualise your codebase.

Currently there is a support only for svn repository.
![TortoiseSVN install](https://github.com/synergy-software/CodeTopology/blob/master/doc/sample01.jpg?raw=true)

Supported repositories:
* Git
* SVN


##How to use it
To generate CodeTopology report run the following script from powershell console

```powershell
.\GenerateReport.ps1 -Verbose -CheckoutDir path_to_your_repository_checkout_dir
.\GenerateReport.ps1 -Verbose -VCS Git -CheckoutDir path_to_your_repository_checkout_dir
```

###Prerequisites
Expand Down

0 comments on commit 4b8c685

Please sign in to comment.