shrukan/cpp-template
Template
1
0
Fork 0
Code Issues 2 Pull Requests Actions Packages Projects Releases 2 Wiki Activity

Add plantuml support to the documentation

Browse Source
This commit is contained in:
Shrukan
2024-02-17 20:27:20 -07:00
parent f040771918
commit e621cb84c7
4 changed files with 8 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
.gitignore vendored
View File

@ -4,3 +4,5 @@ builddir/
subprojects/** subprojects/**
!subprojects/*.wrap !subprojects/*.wrap
!subprojects/.clang-format !subprojects/.clang-format
.cache/

5
Dockerfile
View File

@ -1,7 +1,7 @@
FROM gcc:13 FROM gcc:13
# Install build tools # Install build tools
RUN apt-get update && apt-get install -y python3 python3-pip ninja-build clang-format clang-tidy gdb graphviz git curl zsh \ RUN apt-get update && apt-get install -y python3 python3-pip ninja-build clang-format clang-tidy gdb openjdk-17-jdk-headless graphviz git curl zsh \
&& rm -rf /var/lib/apt/lists/* && rm -rf /var/lib/apt/lists/*
RUN pip install --break-system-packages meson gcovr RUN pip install --break-system-packages meson gcovr
@ -19,6 +19,9 @@ RUN wget -O mold.tar.gz https://github.com/rui314/mold/releases/download/v2.4.0/
ENV CC_LD=mold ENV CC_LD=mold
ENV CXX_LD=mold ENV CXX_LD=mold
# Install plantuml
RUN wget --progress=bar:force:noscroll https://github.com/plantuml/plantuml/releases/download/v1.2024.3/plantuml-mit-1.2024.3.jar -O /usr/local/bin/plantuml.jar
# Install node for actions # Install node for actions
RUN curl -fsSL https://deb.nodesource.com/setup_current.x | bash - && apt-get install -y nodejs RUN curl -fsSL https://deb.nodesource.com/setup_current.x | bash - && apt-get install -y nodejs

5
README.md
View File

@ -4,10 +4,7 @@ ${REPO_DESCRIPTION}
## Build Instructions ## Build Instructions
The provided Docker image includes all necessary dependencies to build and debug The provided Docker image includes all necessary dependencies to build and debug C/C++ applications. While the main build system is Meson, a Justfile is provided for convenience. With dependencies installed, or inside the Docker container, run the following:
C/C++ applications. While the main build system is Meson, a Justfile is provided
for convenience. With dependencies installed, or inside the Docker container, run
the following:
``` ```
Available recipes: Available recipes:

2
docs/Doxyfile.in
View File

@ -2808,7 +2808,7 @@ DIAFILE_DIRS =
# a preprocessing step. Doxygen will generate a warning when it encounters a # a preprocessing step. Doxygen will generate a warning when it encounters a
# \startuml command in this case and will not generate output for the diagram. # \startuml command in this case and will not generate output for the diagram.
PLANTUML_JAR_PATH = PLANTUML_JAR_PATH = /usr/local/bin/plantuml.jar
# When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a # When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a
# configuration file for plantuml. # configuration file for plantuml.