-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
21 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,11 +1,29 @@ | ||
# UML (like) Generator | ||
[![Deploy](https://github.com/Aderinom/ParseToUML/actions/workflows/build-and-deploy-to-pages.yml/badge.svg)](https://github.com/Aderinom/ParseToUML/actions/workflows/build-and-deploy-to-pages.yml) | ||
![](https://github.com/Aderinom/ParseToUML/blob/main/etc/Animation.gif) | ||
|
||
Small tool that generates a UML like graph from C++ like class declarations. | ||
Mostly created this since I wanted to play with 'nearly'. | ||
See : https://aderinom.github.io/ParseToUML/ | ||
|
||
# Starting | ||
Small static site that generates a UML like graph from C++ like class declarations. | ||
Mostly created this since I wanted to play with 'nearly', a parser generator. | ||
|
||
## Tech used | ||
- Vite, React, Mantine | for the frontend | ||
- Nearley, Moo | for text parsing | ||
I'd reccomend PeggyJS instead - easier to use, syntax is more concise, better flexibility | ||
- Viz-Js | for Graph generation | ||
- Eslint | for Linting | ||
|
||
|
||
# Starting in dev | ||
|
||
``` | ||
pnpm i | ||
pnpm dev | ||
``` | ||
|
||
# Building | ||
|
||
``` | ||
pnpm run build | ||
``` |