Fixed README typos

This commit is contained in:
Bartek Kryza
2021-07-25 12:29:01 +02:00
parent ee5c670c07
commit 6b41ccb18f

View File

@@ -9,13 +9,12 @@ existing project code. The configuration file or files for `clang-uml` define th
type and contents of each diagram.
## Features
Main features supported so far include:
* Class diagram generation
* Basic class properties and methods including visibility
* Class relationships including associations, aggregations and friendship
* Template instantiation relationship
* Class relationships including associations, aggregations, dependencies and friendship
* Template instantiation relationships
* Relationship inference from C++ containers and smart pointers
* Namespace based content filtering
* Sequence diagram generation
@@ -31,6 +30,8 @@ that you have the following dependencies installed (example for Ubuntu):
apt install ccache cmake libyaml-cpp-dev libfmt-dev libspdlog-dev clang-12 libclang-12-dev libclang-cpp12-dev
```
Then proceed with building the sources:
```bash
git clone https://github.com/bkryza/clang-uml
cd clang-uml
@@ -49,7 +50,7 @@ export PATH=$PATH:$PWD/release
### Generating compile commands database
`clang-uml` requires an up-to-date
[compile-commands.json](https://clang.llvm.org/docs/JSONCompilationDatabase.html)
[compile_commands.json](https://clang.llvm.org/docs/JSONCompilationDatabase.html)
file, containing the list of commands used for compiling the source code.
Nowadays, this file can be generated rather easily using multiple methods:
* For [CMake](https://cmake.org/) projects, simply invoke the `cmake` command
@@ -59,7 +60,7 @@ Nowadays, this file can be generated rather easily using multiple methods:
### Invocation
By default, `config-uml` will assume that the configuration file `.clanguml`
and compilation database `compilation_database.json` files are in the
and compilation database `compile_commands.json` files are in the
current directory, so if they are in the top level directory of a project,
simply run:
```bash
@@ -77,7 +78,7 @@ clang-uml --help
### Configuration file format and examples
Configuration files are written in YAML, and provide a list of diagrams
which sould be generated by `clang-uml`. Basic example is as follows:
which should be generated by `clang-uml`. Basic example is as follows:
```yaml
compilation_database_dir: .
@@ -255,4 +256,3 @@ The build-in test cases used for unit testing of the clang-uml, can be browsed [
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.