Skip to content

Commit

Permalink
chore: add user guide to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Makcal committed Apr 21, 2024
1 parent 46d1db4 commit 41b49fd
Showing 1 changed file with 28 additions and 1 deletion.
29 changes: 28 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,33 @@
# CppToPlantUML
A simple script that generates a PlantUML class diagram from a C++ source file

## Installation

1. Install [Python 3.11+](https://www.python.org/downloads/release/python-3117/)
2. Install [Poetry](https://python-poetry.org/docs/)
3. Clone the repository.
```bash
git clone https://github.com/Makcal/CppToPlantUML.git
```
4. Install dependencies.
```bash
poetry install --no-root
```

## Usage

Read `pyhton src/main.py --help` for more information.
Produces a PlantUML class diagram from a C++ source file to `out.puml` by default.

```bash
poetry run python src/main.py <source.cpp>
```

You can enjoy and download your diagram for example with [PlantText](https://www.planttext.com/).

### Help

Read help for options and more information:

```bash
poetry run python src/main.py --help
```

0 comments on commit 41b49fd

Please sign in to comment.