mirror of
https://github.com/plantuml-stdlib/C4-PlantUML.git
synced 2022-10-18 01:14:54 +00:00
Merge branch 'patch-1' of https://github.com/patrickp-bosch/C4-PlantUML into latest
This commit is contained in:
@@ -8,7 +8,7 @@
|
||||
|
||||

|
||||
|
||||
C4-PlantUML combines the benefits of [PlantUML](http://en.plantuml.com/) and the [C4 model](https://c4model.com/) for providing a simple way of describing and communicate software architectures - especially during up-front design sessions - with an intuitive language using open source and platform independent tools.
|
||||
C4-PlantUML combines the benefits of [PlantUML](http://en.plantuml.com/) and the [C4 model](https://c4model.com/) for providing a simple way of describing and communicate software architectures – especially during up-front design sessions – with an intuitive language using open source and platform independent tools.
|
||||
|
||||
C4-PlantUML includes macros, stereotypes, and other goodies (like VSCode Snippets) for creating C4 diagrams with PlantUML.
|
||||
|
||||
@@ -24,7 +24,7 @@ C4-PlantUML includes macros, stereotypes, and other goodies (like VSCode Snippet
|
||||
|
||||
At the top of your C4 PlantUML `.puml` file, you need to include the `C4_Context.puml`, `C4_Container.puml` or `C4_Component.puml` file found in the `root` of this repo.
|
||||
|
||||
To be independent of any internet connectifity, you can also download the files found in the `root` and reference it locally with
|
||||
To be independent of any internet connectivity, you can also download the files found in the `root` and reference it locally with
|
||||
|
||||
```c#
|
||||
!include path/to/C4.puml
|
||||
@@ -33,7 +33,7 @@ To be independent of any internet connectifity, you can also download the files
|
||||
!include path/to/C4_Component.puml
|
||||
```
|
||||
|
||||
Just remember to change the `!include` statements inside the top of the files.
|
||||
Just remember to change the `!include` statements at the top of the files.
|
||||
|
||||
If you want to use the always up-to-date version in this repo, use the following:
|
||||
|
||||
@@ -163,4 +163,4 @@ More information can be found here:
|
||||
|
||||
## License
|
||||
|
||||
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details
|
||||
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details
|
||||
|
||||
Reference in New Issue
Block a user