Skip to content

Commit

Permalink
docs: 📝 updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Aderinom committed Mar 3, 2024
1 parent fd131f6 commit fcec504
Showing 1 changed file with 21 additions and 3 deletions.
24 changes: 21 additions & 3 deletions README.md
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
```

0 comments on commit fcec504

Please sign in to comment.