diff --git a/README.md b/README.md index fa7372d1..12209542 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ YAML configuration files. The main idea behind the project is to easily maintain up-to-date diagrams within a code-base or document legacy code. The configuration file or files for `clang-uml` define the type and contents of each generated diagram. -Currently the diagrams are generated in [PlantUML](https://plantuml.com) format. +Currently, the diagrams are generated in [PlantUML](https://plantuml.com) format. `clang-uml` currently supports C++ up to version 17. @@ -46,7 +46,7 @@ More comprehensive documentation can be found [here](./docs/README.md). ## Installation -Installation instruction for `Linux`, `macos` and `Windows` can be found [here](./docs/installation.md). +Installation instructions for `Linux`, `macos` and `Windows` can be found [here](./docs/installation.md). ## Usage @@ -403,6 +403,8 @@ exclude: - clanguml::common::ClassF ``` +More details on this can be found in the [diagram filters](./docs/diagram_filters.md) documentation section. + ### Test cases The build-in test cases used for unit testing of the `clang-uml`, can be browsed [here](./docs/test_cases.md). @@ -420,7 +422,7 @@ This project relies on the following great tools: ## Contributing -If you would like to contribute to the project, please checkout [contributing guidelines](./CONTRIBUTING.md). +If you would like to contribute to the project, please check out [contributing guidelines](./CONTRIBUTING.md). ## LICENSE