Skip to content

Commit a2a8f9d

Browse files
committed
Updating documentation
1 parent 6942f1c commit a2a8f9d

File tree

1 file changed

+19
-2
lines changed

1 file changed

+19
-2
lines changed

README.md

+19-2
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,13 @@ Python script to visualize dependencies between cells in Excel spreadsheets.
88

99
Meant as a tool to visualize and understand the complexity of Excel spreadsheets.
1010

11-
Will generate a graph of the dependencies between cells in an Excel spreadsheet. The graph is generated using the `networkx` library and is visualized using `matplotlib`.
11+
Will generate a graph of the dependencies between cells in an Excel spreadsheet. The graph is generated using the `networkx` library (<https://networkx.org/>) and is visualized using `matplotlib`.
1212

13-
A range reference like `=SUM(A1:A200)` is semantically handled like a single node and not 200 individual nodes in the graph.
13+
## Definitions
14+
15+
Single-cell references in a formula sitting in cell `A3` like `=A1+A2` is considered a dependency between the node `A3` and the nodes `A2` and `A1`.
16+
17+
A range defined in a formula like `=SUM(B1:B200)` is semantically handled like a single reference or node in the tree and not 200 individual nodes in the graph.
1418

1519
<br clear="right"/>
1620

@@ -62,3 +66,16 @@ More in `/images` folder.
6266
```bash
6367
pytest test_cell_reference_extraction.py
6468
```
69+
70+
## Contribute
71+
72+
Feel free to contribute by opening an issue or a pull request.
73+
74+
You can help with the following:
75+
76+
- Add more tests
77+
- Improve the code
78+
- Add more features
79+
- Improve the visualization and the ease of configuration
80+
- Add more examples
81+
- Add more documentation

0 commit comments

Comments
 (0)