Skip to content

Commit f37f31d

Browse files
committed
More README updates
1 parent 7fd4b12 commit f37f31d

File tree

1 file changed

+22
-5
lines changed

1 file changed

+22
-5
lines changed

README.md

Lines changed: 22 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,12 @@
1111

1212
**Emerge** (or **emerge-viz**) is a code analysis tool to gather insights about source code structure, metrics, dependencies and complexity of software projects. You can use it to scan the source code of a project, calculate metric results and statistics, map the source code to graph structures (e.g. a dependency graph or a filesystem graph), export the results in other file formats and even create an **interactive web application** for further exploration. Emerge currently has scanning support for the following languages: `C`, `C++`, `Groovy`, `Java`, `JavaScript`, `TypeScript`, `Kotlin`, `ObjC`, `Ruby`, `Swift`, `Python`. The structure, coloring and clustering is calculated and based on the idea of combining a [force-directed graph](https://github.com/d3/d3-force) simulation and [Louvain modularity](https://github.com/taynaud/python-louvain). emerge is mainly written in Python 3 and is tested on macOS, linux and modern web browsers (i.e. latest Safari, Chrome, Firefox, Edge).
1313

14-
![screenshot 1](https://raw.githubusercontent.com/glato/assets/emerge/emerge-1-1-0-screenshot-01.png)
15-
![screenshot 2](https://raw.githubusercontent.com/glato/assets/emerge/emerge-1-1-0-screenshot-02.png)
16-
![screenshot 3](https://raw.githubusercontent.com/glato/assets/emerge/emerge-1-2-0-screenshot-03.png)
17-
![screenshot 4](https://raw.githubusercontent.com/glato/assets/emerge/emerge-1-1-0-screenshot-05.png)
18-
![screenshot 5](https://raw.githubusercontent.com/glato/assets/emerge/emerge-1-2-0-screenshot-05.png)
14+
![screenshot 1](https://raw.githubusercontent.com/glato/assets/emerge/emerge-1-3-0-screenshot-01.png)
15+
![screenshot 2](https://raw.githubusercontent.com/glato/assets/emerge/emerge-1-3-0-screenshot-02.png)
16+
![screenshot 3](https://raw.githubusercontent.com/glato/assets/emerge/emerge-1-3-0-screenshot-03.png)
17+
![screenshot 4](https://raw.githubusercontent.com/glato/assets/emerge/emerge-1-3-0-screenshot-04.png)
18+
![screenshot 5](https://raw.githubusercontent.com/glato/assets/emerge/emerge-1-3-0-screenshot-05.png)
19+
![screenshot 5](https://raw.githubusercontent.com/glato/assets/emerge/emerge-1-3-0-screenshot-06.png)
1920

2021
## Goals of this project
2122

@@ -457,6 +458,22 @@ analyses:
457458
- d3
458459
```
459460

461+
Sometimes it can make sense to exclude platform-usual dependencies or dependencies which do not contribute much to the understanding of a project. A good starting point for e.g. an **Android project** could the following `ignore_dependencies_containing` section:
462+
463+
```yaml
464+
ignore_dependencies_containing:
465+
- android
466+
- java
467+
- javax
468+
```
469+
470+
or for an **iOS project** the following `ignore_entities_containing` section often makes sense e.g. to not consider SwiftUI previews for the graph output:
471+
472+
```yaml
473+
ignore_entities_containing:
474+
- _Previews
475+
```
476+
460477
The yaml configuration is basically defined at the following levels:
461478

462479
## project level

0 commit comments

Comments
 (0)