https://github.com/arc42/arc42-template

arc42 - the template for software architecture documentation and communication
https://github.com/arc42/arc42-template

arc42 architecture documentation hacktoberfest hacktoberfest2022

Last synced: 3 days ago
JSON representation

arc42 - the template for software architecture documentation and communication

• Host: GitHub
• URL: https://github.com/arc42/arc42-template
• Owner: arc42
• License: other
• Created: 2014-02-13T17:54:36.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2024-05-02T06:43:37.000Z (about 2 months ago)
• Last Synced: 2024-05-02T20:13:12.732Z (about 2 months ago)
• Topics: arc42, architecture, documentation, hacktoberfest, hacktoberfest2022
• Homepage: https://arc42.org
• Size: 66.2 MB
• Stars: 936
• Watchers: 48
• Forks: 169
• Open Issues: 10
• Metadata Files:
  • Readme: README.adoc
  • License: LICENSE.txt

Lists

• awesome-stars - arc42/arc42-template - arc42 - the template for software architecture documentation and communication (Others)
• awesome-starred - arc42/arc42-template - arc42 - the template for software architecture documentation and communication (hacktoberfest)
• jimsghstars - arc42/arc42-template - arc42 - the template for software architecture documentation and communication (Others)

README

        
= image:./small-arc42-logo.png[arc42] Template ("Golden Master")

:version 8.2:

:downloads https://arc42.org/downloads/:

image:https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/banner2-direct.svg[https://vshymanskyy.github.io/StandWithUkraine]

arc42 - the template for effective, practical and pragmatic software architecture

documentation and communication.

Initially created by Dr. Gernot Starke and Dr. Peter Hruschka (way back in 2005...),

free and open source.

This repository contains all downloadable versions plus the (AsciiDoc)

source of the arc42 template.

It is used...

*  as the basis for generating (by the https://github.com/arc42/arc42-generator[arc42-generator] project) the official download formats (i.e. docx, markdown, docbook and others). To generate, THIS repo is included as submodule from the generator project. Use the gradle build contained here just for preview! 

* to maintain structure, content and help for the template

* to keep non-asciidoc, non-generable formats (like Sparx(R) Enterprise-Architect(R) EAP).

In case you find issues within the template or its explanations, this is the repo to fix and issue pull requests :-)

== Revisions

* 8.2: Jan 28th 2023: Thx to A. Bentele, added imagedir def to all files, for easier editing asciidoc. See #178

== Diagrams

We intend to provide all diagrams in platform-neutral formats, mainly `drawio`. 

The source of these diagrams is embedded in a `.png` file. To make this explicit, we use the combined extension `.drawio.png` for our diagrams.

The drawio tools will recognize this and open such files in the editor instead of an image viewer.

Therefore we will gradually remove all files under `./graphics-originals`

== Downloads

Please refer to the https://arc42.org/download[official download page] for

all downloads.

== Languages

The EN and DE versions are actively maintained by the founders (G.Starke & P.Hruschka).

Translations to additional languages (see below) have been provided by volunteers, but won't be automatically updated.

== Build the HTML version 

In case you want to build the HTML version of the template, just checkout this repo and call

----

$> gradle asciidoctor

----

on the command line.

To select another language set the Gradle build property `LANGUAGE` to one of the provided languages, cf.

[source, java]

----

include::gradle.properties[]

----

Currently (March 2022) you need to use **Java 8** to build!

== Questions on using arc42?

* see the extensive https://docs.arc42.org[documentation website]

* see the https://arc42.org[overview] 

== Suggestions welcome

Open an issue here!