From 525b3f74a6a43a2c6d445c2d266cba9602157253 Mon Sep 17 00:00:00 2001 From: Bartek Kryza Date: Fri, 23 Jun 2023 19:54:30 +0200 Subject: [PATCH] Updated docs links --- Makefile | 2 +- README.md | 5 +++-- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/Makefile b/Makefile index 63a03f8c..87ccba7f 100644 --- a/Makefile +++ b/Makefile @@ -142,7 +142,7 @@ docs: doxygen: docs cp CONTRIBUTING.md docs/contributing.md cp CHANGELOG.md docs/changelog.md - cp docs/diagrams/*.svg docs/doxygen/ + cp docs/diagrams/*.svg docs/doxygen/html/ mkdir -p docs/doxygen/html/test_cases cp docs/test_cases/*.svg docs/doxygen/html/test_cases/ ../doxygen/_build/bin/doxygen diff --git a/README.md b/README.md index 8de8e8b6..bb0c1961 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,7 @@ [![Coverage](https://codecov.io/gh/bkryza/clang-uml/branch/master/graph/badge.svg)](https://codecov.io/gh/bkryza/clang-uml) [![Version](https://img.shields.io/badge/version-0.3.7-blue)](https://github.com/bkryza/clang-uml/releases) [![Version](https://img.shields.io/badge/LLVM-12,13,14,15,16-orange)](https://github.com/bkryza/clang-uml/releases) +[![Doxygen](https://img.shields.io/badge/Docs-Doxygen-gainsboro)](https://clanguml-uml.github.io) `clang-uml` is an automatic C++ to UML class, sequence, package and include diagram generator, driven by YAML configuration files. The main idea behind the @@ -16,7 +17,7 @@ The diagrams can be generated in [PlantUML](https://plantuml.com) and JSON forma `clang-uml` currently supports C++ up to version 17 with partial support for C++ 20. -Full documentation can be found [here](./docs/README.md). +Full documentation can be found at [clanguml-uml.github.io](https://clanguml-uml.github.io). To see what `clang-uml` can do, checkout the diagrams generated for unit test cases [here](./docs/test_cases.md) or examples in @@ -55,7 +56,7 @@ Main features supported so far include: * **Include graph diagram generation** * Show include graph for selected files - [_example_](docs/test_cases/t40001.md) -More comprehensive documentation can be found [here](./docs/README.md). +More comprehensive documentation can be at [clanguml-uml.github.io](https://clanguml-uml.github.io). ## Installation