Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
milanm committed Jun 18, 2024
1 parent 6d1ad9e commit bf2a5c6
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Software Architecture Documentation with arc42 and C4 Model

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.
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.

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

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

## Technologies Used

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

## Directory Structure
Expand Down

0 comments on commit bf2a5c6

Please sign in to comment.