Skip to content

Commit bf2a5c6

Browse files
committed
Update README
1 parent 6d1ad9e commit bf2a5c6

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Software Architecture Documentation with arc42 and C4 Model
22

3-
This repository provides an example of generating architecture documentation using the arc42 template and the C4 model, with the help of Structurizr CLI and Asciidoctor. The documentation includes various architectural views and diagrams, generated automatically using Docker and Docker Compose locally, or by using GitHub pages.
3+
This repository provides an example of generating architecture documentation using the [arc42 template](https://arc42.org/) and the [C4 model](https://c4model.com/), with the help of Structurizr CLI and Asciidoctor. The documentation includes various architectural views and diagrams, generated automatically using Docker and Docker Compose locally, or by using GitHub pages.
44

55
The complete explanation of the process is explain in [the text](https://newsletter.techworld-with-milan.com/p/documenting-software-architectures).
66

@@ -25,8 +25,11 @@ The repository demonstrates how to:
2525

2626
## Technologies Used
2727

28+
- **[arc42 template](https://arc42.org/)**: Used to define a structure of documentation.
2829
- **[Structurizr DSL](https://structurizr.com/help/dsl)**: Used to define the architecture model.
30+
- **[Structurizr CLI](https://github.com/structurizr/cli)**: Used to export [PlantUML diagrams](https://plantuml.com/) from Structurizr DSL.
2931
- **[PlantUML](http://plantuml.com/)**: Used to generate UML diagrams.
32+
- **[AsciiDoc](https://asciidoc.org/)**: Used as a markup language for documents.
3033
- **[Asciidoctor](https://asciidoctor.org/)**: Used to convert AsciiDoc files to HTML.
3134

3235
## Directory Structure

0 commit comments

Comments
 (0)