Skip to content

Commit 6ee2bfa

Browse files
committed
Fixed minor typos in README
1 parent 4e724a0 commit 6ee2bfa

File tree

2 files changed

+12
-12
lines changed

2 files changed

+12
-12
lines changed

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -17,12 +17,11 @@ types and contents of each generated diagram.
1717
The diagrams can be generated in [PlantUML](https://plantuml.com),
1818
[MermaidJS](https://mermaid.js.org/) and JSON formats.
1919

20-
`clang-uml` currently supports C++ up to version 17 with partial support for C++ 20,
21-
as well as C and Objective-C.
20+
`clang-uml` currently supports C++ up to version 20, as well as C and Objective-C.
2221

2322
Full documentation can be found at [clang-uml.github.io](https://clang-uml.github.io).
2423

25-
To see what `clang-uml` can do, checkout the diagrams generated for unit
24+
To see what `clang-uml` can do, check out the diagrams generated for unit
2625
test cases [here](./docs/test_cases.md) or examples in
2726
[clang-uml-examples](https://github.com/bkryza/clang-uml-examples) repository.
2827

@@ -106,17 +105,18 @@ clang-uml
106105
```
107106

108107
The output path for diagrams, as well as alternative location of
109-
compilation database can be specified in `.clang-uml` configuration file.
108+
compilation database can be specified in `.clang-uml` configuration file or
109+
through command line parameters.
110110

111-
For other options checkout help:
111+
For other options see help:
112112

113113
```bash
114114
clang-uml --help
115115
```
116116

117117
### Configuration file format and examples
118118

119-
Configuration files are written in YAML, and provide a list of diagrams
119+
Configuration files are written in YAML, and provide definition of diagrams
120120
which should be generated by `clang-uml`. Basic example is as follows:
121121

122122
```yaml
@@ -143,7 +143,7 @@ See [here](docs/configuration_file.md) for detailed configuration file reference
143143
144144
## Examples
145145
146-
To see what `clang-uml` can do, checkout the test cases documentation [here](./docs/test_cases.md).
146+
To see what `clang-uml` can do, browse the test cases documentation [here](./docs/test_cases.md).
147147

148148
In order to see diagrams for the `clang-uml` itself, based on its own [config](.clang-uml) run
149149
the following:
@@ -152,7 +152,7 @@ the following:
152152
make clanguml_diagrams
153153
```
154154

155-
and checkout the SVG diagrams in `docs/diagrams` folder.
155+
and open the SVG diagrams in `docs/diagrams` folder.
156156

157157
### Class diagrams
158158

@@ -228,7 +228,7 @@ results in the following diagram (via PlantUML):
228228
![class_diagram_example](docs/test_cases/t00014_class.svg)
229229

230230
> Open the raw image [here](https://raw.githubusercontent.com/bkryza/clang-uml/master/docs/test_cases/t00014_class.svg),
231-
> and checkout the hover tooltips and hyperlinks to classes and methods.
231+
> and check out the hover tooltips and hyperlinks to classes and methods.
232232

233233
### Sequence diagrams
234234

@@ -366,7 +366,7 @@ results in the following diagram (via PlantUML):
366366
### Include diagrams
367367

368368
> In case you're looking for a simpler tool to visualize and analyze include graphs
369-
> checkout my other tool - [clang-include-graph](https://github.com/bkryza/clang-include-graph)
369+
> check out my other tool - [clang-include-graph](https://github.com/bkryza/clang-include-graph)
370370

371371
#### Example
372372

@@ -403,7 +403,7 @@ results in the following diagram (via PlantUML) based on include directives in t
403403

404404
### Diagram content filtering
405405

406-
For typical code bases, generating a single diagram from entire code or even a single namespace can be too big to
406+
For typical code bases, a single diagram generated from an entire code or even a single namespace can be too big to
407407
be useful, e.g. as part of documentation. `clang-uml` allows specifying content to be included and excluded from
408408
each diagram using simple YAML configuration:
409409

docs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ The diagrams can be generated in [PlantUML](https://plantuml.com),
1313
Example sequence diagram generated using `clang-uml` from [this code](https://github.com/bkryza/clang-uml/blob/master/tests/t20029/t20029.cc):
1414
![Sample sequence diagram](test_cases/t20029_sequence.svg)
1515

16-
`clang-uml` currently supports C++ up to version 17 with partial support for C++ 20.
16+
`clang-uml` currently supports C++ up 20, as well as C and Objective-C.
1717

1818
To see what `clang-uml` can do, checkout the diagrams generated for unit
1919
test cases [here](./test_cases.md) or examples in

0 commit comments

Comments
 (0)