Added initial documentation

docs/quick_start.md

@@ -0,0 +1,56 @@
+# Quick start
+
+To add an initial class diagram to your project, follow these steps:
+
+1. Enter your projects top level directory and run:
+    ```bash
+      $ clang-uml --init
+    ```
+2. Edit the generated `.clang-uml` file and set the following:
+    ```yaml
+    # Path to `compile_commands.json` directory
+    compilation_database_dir: .
+    # Path to diagram output directory
+    output_directory: puml
+    diagrams:
+      # This is the name of the diagram
+      some_class_diagram:
+        type: class
+        # Parse only translation units in `src` subdirectory
+        glob:
+          - src/*.cc
+        # Render all names relative to `myproject` namespace
+        using_namespace:
+          - myproject
+        include:
+          # Include only elements in `myproject` namespace
+          namespaces:
+            - myproject
+        exclude:
+          # Exclude elements in `myproject::detail` namespace
+          namespaces:
+            - myproject::detail
+      ```
+3. Run `clang-uml` in the projects top directory:
+    ```bash
+    $ clang-uml
+    ```
+4. Generate SVG images from the PlantUML diagrams:
+    ```bash
+   $ plantuml -tsvg puml/*.puml
+   ```
+5. Add another diagram:
+   ```bash
+   $ clang-uml --add-sequence-diagram another_diagram
+   ```
+6. Now list the diagrams defined in the config:
+   ```bash
+   $ clang-uml -l
+   The following diagrams are defined in the config file:
+     - another_diagram [sequence]
+     - some_class_diagram [class]
+   ```
+7. Generate only the new diagram:
+   ```bash
+   clang-uml -n another_diagram
+   ```