From b561dfdb24103d384b21260c8bcd124ec96e0fb9 Mon Sep 17 00:00:00 2001 From: msclock Date: Tue, 28 Nov 2023 06:10:27 +0800 Subject: [PATCH] docs: temp WIP Signed-off-by: msclock --- .vscode/settings.json | 3 ++- CMakePresets.json | 5 ++++- CONTRIBUTING.md | 4 ++-- docs/contributing.md | 2 ++ docs/development.md | 2 ++ docs/index.md | 2 ++ 6 files changed, 14 insertions(+), 4 deletions(-) create mode 100644 docs/contributing.md create mode 100644 docs/development.md diff --git a/.vscode/settings.json b/.vscode/settings.json index a85a2c57..c4ed526f 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -1,5 +1,6 @@ { "cmake.useCMakePresets": "always", + "cmake.options.statusBarVisibility": "visible", "files.exclude": { "**/.clangd/**": true }, @@ -97,5 +98,5 @@ "memory_resource": "cpp", "numbers": "cpp", "semaphore": "cpp" - }, + } } diff --git a/CMakePresets.json b/CMakePresets.json index 87f95f2c..f12899b4 100644 --- a/CMakePresets.json +++ b/CMakePresets.json @@ -8,7 +8,10 @@ "generator": "Ninja", "hidden": true, "binaryDir": "${sourceDir}/out/build/${presetName}", - "installDir": "${sourceDir}/out/install/${presetName}" + "installDir": "${sourceDir}/out/install/${presetName}", + "cacheVariables": { + "CMAKE_VERBOSE_MAKEFILE": "FALSE" + } }, { "name": "x64", diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b695d876..b86a2996 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -36,7 +36,7 @@ Commit messages must follow our convention based on the [Angular style](https://gist.github.com/stephenparish/9941e89d80e2bc58a153#format-of-the-commit-message) or the [Karma convention](https://karma-runner.github.io/4.0/dev/git-commit-msg.html): -```txt +```tex [(scope)]: Subject [Body] @@ -65,7 +65,7 @@ If you write a body, please add trailers at the end (for example issues and PR references, or co-authors), without relying on GitHub's flavored Markdown: -```txt +```tex Body. Issue #10: https://github.com/namespace/project/issues/10 diff --git a/docs/contributing.md b/docs/contributing.md new file mode 100644 index 00000000..78caf34e --- /dev/null +++ b/docs/contributing.md @@ -0,0 +1,2 @@ +```{include} ../CONTRIBUTING.md +``` diff --git a/docs/development.md b/docs/development.md new file mode 100644 index 00000000..a22ceedc --- /dev/null +++ b/docs/development.md @@ -0,0 +1,2 @@ +# Development + diff --git a/docs/index.md b/docs/index.md index 42dadd0c..9a0841df 100644 --- a/docs/index.md +++ b/docs/index.md @@ -4,6 +4,8 @@ :hidden: Overview cmake_workflow +development +contributing changelog api coverage