Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
8 changes: 8 additions & 0 deletions .markdownlint.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"MD013": {
"line_length": 100
},
"MD024": {
"siblings_only": true
}
}
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -63,25 +63,25 @@ 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`.

## Prerequisites

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.

Expand Down