Skip to content

README.md

Latest commit

 

History

History
79 lines (64 loc) · 4.86 KB

README.md

File metadata and controls

79 lines (64 loc) · 4.86 KB
name C4
display_name C4 (C4-PlantUML)
description The C4 library enables a simple way of describing and communicate software architectures with an intuitive language.
author Ricardo Niepel, kirchsth and contributors
version 2.12.1
release https://github.com/plantuml-stdlib/C4-PlantUML/tree/release/v2.12.0
license MIT
source https://github.com/plantuml-stdlib/C4-PlantUML
origin https://c4model.com

C4 specific stdlib properties:
name: C4 display_name: C4 (C4-PlantUML)
version: 2.12.1 release: https://github.com/plantuml-stdlib/C4-PlantUML/tree/release/v2.12.0 patched
description: The C4 library enables a simple way of describing and communicate software architectures with an intuitive language.
license: MIT author: Ricardo Niepel, kirchsth and contributors
source: https://github.com/plantuml-stdlib/C4-PlantUML origin: https://c4model.com

Support and community:
issues: C4 open master commits
discussions: C4

[!INFORMATION] C4 library is patched to version 2.12.1: This version contains the Fix for "Use !option handwritten true" warning too.

C4 library (C4-PlantUML) [C4]

The C4 library enables a simple way of describing and communicate software architectures with an intuitive language.

It is the PlantUML integrated version of C4-PlantUML and has the big advantage that it can be used without additional external includes. (E.g. container diagrams can be drawn with !include <C4/C4_Container> and no !include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml is required.)

Example of usage:

@startuml
!include <C4/C4_Container>
LAYOUT_LEFT_RIGHT()

Person(admin, "Administrator")
System_Boundary(c1, "Sample System") {
    Container(web_app, "Web Application", "C#, ASP.NET Core 2.1 MVC", "Allows users to compare multiple Twitter timelines")
}
System(twitter, "Twitter")

Rel(admin, web_app, "Uses", "HTTPS")
Rel(web_app, twitter, "Gets tweets from", "HTTPS")

SHOW_LEGEND()
@enduml

renders following image:

Example