Skip to content

Commit a98d24f

Browse files
authored
Add README for Formal Mathematics Library Visualizer
This README introduces a GitHub Action for generating visualizations of formal mathematics libraries in Agda, detailing its steps and providing a live example link.
1 parent 7cb26aa commit a98d24f

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Formal Mathematics Library Visualizer
2+
3+
## Overview
4+
5+
This GitHub Action automatically generates interactive visualizations for formal mathematics libraries written in **Agda**.
6+
7+
Designed to integrate seamlessly into CI/CD pipelines, the tool performs the following steps:
8+
1. **Environment Setup**: runs within a Docker container with pre-configured compilers (Agda, GHC) and Python dependencies.
9+
2. **Compilation**: Type-checks the library and generates structural data (e.g., Agda S-expressions).
10+
3. **Processing**: Parses the module dependencies and definitions to construct a directed graph.
11+
4. **Visualization**: Outputs web-ready assets (interactive graphs, standalone HTML, or embeddable components) that can be deployed directly to GitHub Pages.
12+
13+
## Result
14+
15+
You can view a live example of the visualization generated for the **Agda Unimath** library here:
16+
17+
[**https://unimath.github.io/agda-unimath/VISUALIZATION.html**](https://unimath.github.io/agda-unimath/VISUALIZATION.html)

0 commit comments

Comments
 (0)