Skip to content

Commit c899fff

Browse files
Added README.
1 parent ccb638a commit c899fff

File tree

1 file changed

+46
-0
lines changed

1 file changed

+46
-0
lines changed

README.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Spreadsheet Mapping Tool
2+
Given a `.xlsx` file, gives you a graph of the cell formula dependencies. Useful for visualizing the inner workings of large spreadsheets.
3+
4+
![Example rendered graph](/example_output.png?raw=true "Example Graph")
5+
6+
## Getting Started
7+
8+
These instructions will get you a copy of the project up and running on your local machine for development and usage purposes.
9+
10+
### Prerequisites
11+
Java
12+
13+
Gradle (to build, otherwise grab a `.jar` from Releases
14+
15+
Graphvis (sudo apt install graphviz)
16+
17+
18+
### Building (Skip to Using just interested in basic use)
19+
20+
You can import the project as an IntelliJ project, or if you prefer the command line, just
21+
22+
```
23+
gradle jar
24+
```
25+
26+
### Using
27+
Run the tool from the command line and pipe the output into graphvis:
28+
29+
```
30+
# java -jar excel-mapper.jar test.xlsx | dot -Tpng -o example_output.png
31+
```
32+
33+
34+
## Built With
35+
36+
* [Apache POI](https://poi.apache.org/) - For all of the gnarly formula parsing
37+
* [Gradle](https://maven.apache.org/) - Dependency Management
38+
39+
## Contributing
40+
41+
Send in a pull request with whatever you'd like. Additions necessary:
42+
* Test with non-Apache-POI-supported functions in the spreadsheet, like custom VisualBasic functions.
43+
* This should work fine since we're not actually evaluating any functions, only cell formula contents, but is untested.
44+
45+
This project is licensed under the MIT License.
46+

0 commit comments

Comments
 (0)