Skip to content

Commit 142932d

Browse files
committed
Adds a small description about the goal of this repository in the README.md
1 parent e924750 commit 142932d

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
# Module Map visualizer
1+
# Module Map Visualizer
2+
3+
This repository contains some python scripts which purpose is to generate a graphical representation of the relationships module-submodule existing between the repositories of a GitHub organization.
24

35
## Requirements
46

@@ -26,4 +28,4 @@ python scripts/repository_dependencies.py -o < name_of_your_github_organization
2628
python scripts/repository_dependencies.py --help
2729
```
2830

29-
Be careful, the private repositories of the GitHUb organisation will be displayed in the graph generated, if you have the GitHub access to those repositories. Take that information into account if you plan on sharing the generated graphs 😉
31+
Be careful, the private repositories of the GitHub organization will be displayed in the graph generated, if you have the GitHub access to those repositories. Take that information into account if you plan on sharing the generated graphs 😉

0 commit comments

Comments
 (0)