# Introduction

crystal-facet-uml creates diagrams to document system and software architecture.

Like a crystal shows different facets of the same thing, this application shows different views of the same software or system.

## Goal

As software architect, you create a set of diagrams describing use-cases, requirements, structural views, behavioral and deployment views.

These views show selected elements and their relationships. crystal-facet-uml keeps element names and element hierarchies consistent.

This tool runs on your local PC. It stores the model data in a json-based file which can be versioned in git, branched and merged together with your source code. crystal-facet-uml exports diagrams as svg, pdf, ps, png or the complete model as DocBook, html, json or xmi.

## Features

## Usage Overview

crystal-facet-uml can be started in graphical mode (see gui_main) or from command line (see cli_main).