Boilerplate

.gitattributes

@@ -1,17 +1,99 @@
-*.c linguist-language=C
-*.cmake linguist-vendored
-*.cmd linguist-detectable=false
-*.cpp linguist-language=C++
-*.cxx linguist-language=C++
-*.dsp linguist-detectable=false
-*.dsw linguist-detectable=false
-*.h linguist-language=C
-*.hpp linguist-language=C++
-*.html linguist-detectable=false
-*.hxx linguist-language=C++
-*.sh linguist-detectable=false
-*.sln linguist-detectable=false
-*.vcxproj linguist-detectable=false
-*.vimrc linguist-detectable=false
-CMakeLists.txt linguist-vendored
-makefile linguist-detectable=false
+# .gitattributes — C++ (GitHub-hosted)
+#
+# Sources: GitHub Docs (line endings), git-scm gitattributes (diff=cpp),
+# gitattributes/gitattributes C++.gitattributes + Common.gitattributes,
+# github-linguist overrides.
+
+# Default: detect text, normalize to LF in the repository
+* text=auto
+
+# --- Source ---
+*.c text diff=cpp
+*.c++ text diff=cpp
+*.cc text diff=cpp
+*.cpp text diff=cpp
+*.cxx text diff=cpp
+*.h text diff=cpp
+*.h++ text diff=cpp
+*.hh text diff=cpp
+*.hpp text diff=cpp
+*.hxx text diff=cpp
+*.inc text
+*.inl text
+*.ipp text
+*.tcc text
+*.tpp text
+
+# --- Build / config ---
+*.am text
+*.cmake text
+*.m4 text
+*.mak text
+*.mk text
+*akefile text
+CMakeLists.txt text
+configure text eol=lf
+configure.ac text
+
+# --- Scripts ---
+*.bash text eol=lf
+*.bat text eol=crlf
+*.cmd text eol=crlf
+*.ps1 text eol=crlf
+*.sh text eol=lf
+*.zsh text eol=lf
+
+# --- Docs / meta ---
+*.adoc text
+*.markdown text diff=markdown
+*.md text diff=markdown
+*.txt text
+AUTHORS text
+CHANGELOG text
+CHANGES text
+CONTRIBUTING text
+COPYING text
+LICENSE text
+NEWS text
+README text
+TODO text
+.gitattributes text
+.gitignore text
+
+# --- Serialisation ---
+*.json text
+*.toml text
+*.xml text
+*.yaml text
+*.yml text
+
+# --- Compiled / binary artefacts ---
+*.a binary
+*.dll binary
+*.dylib binary
+*.exe binary
+*.gch binary
+*.la binary
+*.lai binary
+*.lib binary
+*.lo binary
+*.o binary
+*.obj binary
+*.out binary
+*.pch binary
+*.slo binary
+*.so binary
+
+# --- Archives / images (common) ---
+*.gif binary
+*.gz binary
+*.ico binary
+*.jpeg binary
+*.jpg binary
+*.png binary
+*.tar binary
+*.zip binary
+
+# --- GitHub Linguist ---
+**/build/** linguist-generated
+**/cmake-build-*/** linguist-generated

.github/workflows/ci.yml

@@ -4,7 +4,12 @@ on:
   push:
     branches:
       - master
+      - dev
       - boilerplate
+      - idiomatic
+      - rc1
+      - rc2
+      - rc3
   pull_request:
 
 concurrency:

.vscode/settings.json

@@ -5,6 +5,8 @@
 		"editor.tabSize": 4,
 	},
 	"[c]": {
+		"editor.defaultFormatter": "ms-vscode.cpptools",
+		"editor.formatOnSave": true,
 		"editor.insertSpaces": true,
 		"editor.rulers": [ 60, 64, 68, 72, 76 ],
 		"editor.tabSize": 4,
@@ -14,6 +16,8 @@
 		"editor.tabSize": 4,
 	},
 	"[cpp]": {
+		"editor.defaultFormatter": "ms-vscode.cpptools",
+		"editor.formatOnSave": true,
 		"editor.insertSpaces": true,
 		"editor.rulers": [ 60, 64, 68, 72, 76 ],
 		"editor.tabSize": 4,
@@ -49,7 +53,17 @@
 		"editor.insertSpaces": true,
 		"editor.tabSize": 2,
 	},
+	"C_Cpp.autocompleteAddParentheses": true,
+	"C_Cpp.clang_format_fallbackStyle": "none",
+	"C_Cpp.clang_format_style": "file",
+	"C_Cpp.default.cStandard": "c17",
+	"C_Cpp.default.cppStandard": "c++17",
+	"C_Cpp.enhancedColorization": "enabled",
+	"C_Cpp.errorSquiggles": "enabled",
+	"C_Cpp.formatting": "clangFormat",
+	"C_Cpp.intelliSenseEngine": "default",
 	"cmake.configureOnOpen": false,
+	"debug.allowBreakpointsEverywhere": true,
 	"editor.detectIndentation": false,
 	"editor.insertSpaces": false,
 	"editor.renderWhitespace": "all",
@@ -128,10 +142,13 @@
 		"numeric": "cpp",
 		"optional": "cpp",
 		"ostream": "cpp",
+		"print": "cpp",
 		"queue": "cpp",
 		"random": "cpp",
 		"ranges": "cpp",
 		"ratio": "cpp",
+		"rc.h": "c",
+		"result_codes_.h": "c",
 		"semaphore": "cpp",
 		"set": "cpp",
 		"setenv.h": "c",
@@ -180,4 +197,3 @@
 	"files.trimTrailingWhitespace": true,
 	"git.mergeEditor": false,
 }
-

CHANGES.md

@@ -1,7 +1,11 @@
 # **realpath** Changes <!-- omit in toc -->
 
 
-## 0.0.3 - 3rd August 2026
+## 0.1.0 - 6th August 2026
+
+
+
+## 0.0.3 - 5th August 2026
 
 * Added modular GitHub Actions CI (**ci.yml** / **ci-cell.yml**) for Windows (Windows-only tool);
 * Modernised **CMakeLists.txt** (explicit Windows-only guard; **STLSoft** discovery/`STLSOFT` override; MSVC options; `BUILD_TESTING`);

CMakeLists.txt

@@ -4,7 +4,7 @@
 # Purpose:  Top-level CMake lists file for realpath
 #
 # Created:  31st December 2024
-# Updated:  3rd August 2026
+# Updated:  5th August 2026
 #
 # ######################################################################## #
 
@@ -56,10 +56,16 @@ set(PROJECT_VERSION "${PROJECT_VERSION_MAJOR}.${PROJECT_VERSION_MINOR}.${PROJECT
 
 # adhere strictly to C and C++ standards plus extensions. These are actually
 # useless since we do not compile anything; they merely state our intention.
-set(CMAKE_C_STANDARD 17)
+if(NOT CMAKE_C_STANDARD)
+
+	set(CMAKE_C_STANDARD 17)
+endif()
 set(CMAKE_C_STANDARD_REQUIRED ON)
 set(CMAKE_C_EXTENSIONS ON) # GNU extensions and POSIX standard
-set(CMAKE_CXX_STANDARD 17)
+if(NOT CMAKE_CXX_STANDARD)
+
+	set(CMAKE_CXX_STANDARD 17)
+endif()
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
 set(CMAKE_CXX_EXTENSIONS ON)
 
@@ -227,7 +233,7 @@ endif(BUILD_TESTING)
 # ##########################################################
 # completion
 
-message(NOTICE "Generating CMake build scripts for ${PROJECT_NAME} ${PROJECT_VERSION}, for C${CMAKE_C_STANDARD} C++${CMAKE_CXX_STANDARD}")
+message(NOTICE "Generating CMake build scripts for ${PROJECT_NAME} ${PROJECT_VERSION}, for C${CMAKE_C_STANDARD} C++${CMAKE_CXX_STANDARD}, with build type ${CMAKE_BUILD_TYPE}")
 
 
 # ############################## end of file ############################# #

INSTALL.md

@@ -66,4 +66,49 @@ The primary choice for installation is by use of **CMake** on Windows.
     ```
 
 
+## Requisites
+
+**realpath** requires:
+
+* [**STLSoft**](https://github.com/synesissoftware/STLSoft), version 1.11.1
+  or later;
+* CMake 3.20 or later;
+* a Windows C/C++ toolchain supported by CMake.
+
+
+## Building
+
+The primary build method is CMake. From PowerShell:
+
+```powershell
+git clone https://github.com/sistools/realpath.git
+Set-Location realpath
+cmake -S . -B _build
+cmake --build _build --config Release
+```
+
+The resulting executable is `_build/Release/realpath.exe`.
+
+
+## Installing
+
+To install into a user-local directory:
+
+```powershell
+cmake --install _build --config Release --prefix "$env:LOCALAPPDATA\Programs\realpath"
+```
+
+The installed executable is placed in the `bin` directory beneath the
+selected prefix.
+
+
+## Testing
+
+Configure the project with `-DBUILD_TESTING=ON` to build its tests, then run:
+
+```powershell
+ctest --test-dir _build -C Release --output-on-failure
+```
+
+
 <!-- ########################### end of file ########################### -->

README.md

@@ -4,6 +4,7 @@ Windows analogue of the Unix **realpath**(1) utility.
 
 
 ![C++](https://img.shields.io/badge/C%2B%2B-00599C?style=flat&logo=c%2B%2B&logoColor=white)
+![Windows](https://img.shields.io/badge/OS-Windows-0078D6?style=flat&logo=windows&logoColor=white)
 [![License](https://img.shields.io/badge/License-BSD_3--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)
 [![GitHub release](https://img.shields.io/github/v/release/sistools/realpath.svg)](https://github.com/sistools/realpath/releases/latest)
 [![Last Commit](https://img.shields.io/github/last-commit/sistools/realpath)](https://github.com/sistools/realpath/commits/master)
@@ -58,29 +59,36 @@ C:\Users\...\sistools\realpath
 
 ### Contribution guidelines
 
-Defect reports, feature requests, and pull requests are welcome on [the **realpath** GitHub page](https://github.com/sistools/realpath).
+Defect reports, feature requests, and pull requests are welcome on [the
+**realpath** GitHub page](https://github.com/sistools/realpath).
 
 
 ### Dependencies
 
 **realpath** depends on:
 
-* [**STLSoft**](https://github.com/synesissoftware/STLSoft) (1.11+; **WinSTL**);
+* [**STLSoft**](https://github.com/synesissoftware/STLSoft) (1.11+; **WinSTL**, **PlatformSTL**);
 
 
 ### Related projects
 
-Other (similar) projects include:
+Other **sistools** projects include:
 
 * [**chomp**](https://github.com/sistools/chomp);
+* [**errni**](https://github.com/sistools/errni) (errno on all platforms, and also GetLastError codes on Windows);
+* [**lnunique**](https://github.com/sistools/lnunique);
+* [**lslocales**](https://github.com/sistools/lslocales);
 * [**lstrip**](https://github.com/sistools/lstrip);
-* [**mksock**](https://github.com/sistools/mksock);
+* [**mksock**](https://github.com/sistools/mksock) (Unix-only);
+* [**ReadDebugString**](https://github.com/sistools/ReadDebugString) (Windows-only);
 * [**rstrip**](https://github.com/sistools/rstrip);
+* [**WriteDebugString**](https://github.com/sistools/WriteDebugString) (Windows-only);
 
 
 ### License
 
-**realpath** is released under the 3-clause BSD license. See [LICENSE](./LICENSE) for details.
+**realpath** is released under the 3-clause BSD license. See [LICENSE](./LICENSE)
+for details.
 
 
 <!-- ########################### end of file ########################### -->

TODO.md

@@ -1,10 +1,11 @@
 # realpath - TODO list
 
 
-## mksock 0.0.x TODOs:
+## realpath 0.0.x TODOs:
 
-* \<none>
+* Review and expand **INSTALL.md** as the build and dependency requirements evolve;
+* Add **REQUISITES.md** (at least **STLSoft**);
+* Set GitHub repository topics: `cpp`, `cli`, `command-line`, `cmake`, `stlsoft`, `windows`, `win32`, `filesystem`, `path`, `bsd-3-clause`, `sistools`;
 
 
 <!-- ########################### end of file ########################### -->
-