From aa66ec72425aa5015d4e1ba2de58bf97bb45afe9 Mon Sep 17 00:00:00 2001 From: Yury Bayda Date: Sun, 2 Aug 2026 21:21:02 -0700 Subject: [PATCH] ci: align Markdown documentation --- .github/workflows/main.yml | 5 +++++ .markdownlint.json | 8 ++++++++ README.md | 20 ++++++++++---------- 3 files changed, 23 insertions(+), 10 deletions(-) create mode 100644 .markdownlint.json diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index f4a77e1..4644b97 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -13,6 +13,11 @@ jobs: steps: - uses: actions/checkout@v7 + - name: Lint Markdown + uses: DavidAnson/markdownlint-cli2-action@v23 + with: + globs: "**/*.md" + - name: Check formatting run: make format-check diff --git a/.markdownlint.json b/.markdownlint.json new file mode 100644 index 0000000..2bf8ad4 --- /dev/null +++ b/.markdownlint.json @@ -0,0 +1,8 @@ +{ + "MD013": { + "line_length": 100 + }, + "MD024": { + "siblings_only": true + } +} diff --git a/README.md b/README.md index a36a9b0..1f5c1e3 100644 --- a/README.md +++ b/README.md @@ -53,7 +53,7 @@ In this phase, the objective is to develop a function `from_roman(number: str) -> int` that performs the reverse conversion, transforming Roman numerals into their corresponding Arabic digits. -## Guiding Principles +## Guiding principles * If you don't know an existing algorithm, follow the principles of strict Test-Driven Development (TDD) to derive one. @@ -63,7 +63,7 @@ their corresponding Arabic digits. on TDD, especially if you don't already know one. * If you do know an algorithm, evaluate if it can be implemented using strict TDD principles. - + This is a C++17 kata using GoogleTest. Setup is complete when CTest reports `100% tests passed`. @@ -71,17 +71,17 @@ This is a C++17 kata using GoogleTest. Setup is complete when CTest reports Required: -- [Git](https://git-scm.com/downloads) -- A compiler with C++17 support. Choose one: - - [GCC](https://gcc.gnu.org/) 10+ on Linux - - [LLVM Clang](https://llvm.org/) 14+ on Linux - - [Apple Clang](https://developer.apple.com/xcode/) 17+ on macOS - - [MSVC](https://visualstudio.microsoft.com/) 2022 on Windows -- [CMake 3.24 or later](https://cmake.org) +* [Git](https://git-scm.com/downloads) +* A compiler with C++17 support. Choose one: + * [GCC](https://gcc.gnu.org/) 10+ on Linux + * [LLVM Clang](https://llvm.org/) 14+ on Linux + * [Apple Clang](https://developer.apple.com/xcode/) 17+ on macOS + * [MSVC](https://visualstudio.microsoft.com/) 2022 on Windows +* [CMake 3.24 or later](https://cmake.org) Optional: -- [GNU Make](https://www.gnu.org/software/make/), for shorter commands. Every +* [GNU Make](https://www.gnu.org/software/make/), for shorter commands. Every required task also has direct CMake and CTest commands. Make may be unavailable on Windows.