CppToday

A minimal but complete Make-based C++23 project template.

This project packages a simple C++23 command-line program with essential tools and workflows for building, testing, and maintaining the code. The program prints the current date in the YY/MM/DD = Www format (e.g. 25/05/14 = Wed).

Project website: aafulei.github.io/cpp-today.

• Features
• Supported Platforms
• Getting Started
• Project Structure
• Project Website
• Author
• License
• Version
• Changelog

Features

• Minimal, complete C++23 project template
• All-in-one Make-based build system
• Test scripts for manual and automated testing
• Code formatting support with Clang Format
• Editor tooling support via Clangd
• Built-in CI/CD workflows using GitHub Actions
• Project documentation website built with MkDocs
• Source code documentation generated with Doxygen
• Software documentation in GNU-style man page

Supported Platforms

• macOS
• Linux

Getting Started

Download

Download pre-built binaries and the accompanying man page from the Release page.

Alternatively, you can build the program from source as shown below.

Build

Clone the GitHub repository. Then use make to build the program:

make

Run

• If you downloaded the binary from the Release page, follow the instructions there.

• If you built the program yourself using make, you can run it with:

  make run

  Alternatively, to run manually:

  ./bin/release/today

You should see the current date printed out in the YY/MM/DD = Www format, for example:

25/05/14 = Wed

Install

To install the program, run:

make install

The man page will be installed alongside the program. You might need sudo privileges. Run make help for customization options. To install the binary and the man page manually, copy them to their default destinations or to directories of your choice:

Source	Default Destination
./bin/release/today	/usr/local/bin/
./docs/man/today.1	/usr/local/share/man/man3/

To uninstall the program and the man page, run:

make uninstall

Ask for Help

As is typical with command-line programs, run:

today --help

for help. If the man page has been installed, you can run:

man today

to view the manual page for more information.

For detailed user guides, please visit the project website aafulei.github.io/cpp-today.

Project Structure

• .github/workflows/ — GitHub Actions workflows
• docs/ — project documentation files and assets
  • css/ — custom CSS files for MkDocs and Doxygen
  • img/ — image files
  • man/ - man page files
  • mermaid/ - source files for Mermaid diagrams
  • .md files - source files for MkDocs to generate the project website
• src/ — source code
• tests/ — test scripts
• .clang-format — Clang Format configuration
• .gitignore — Git ignore patterns
• CHANGELOG.md — changelog
• Doxyfile — Doxygen configuration file
• DoxygenLayout.xml — Doxygen website layout
• LICENSE — license file
• Makefile — Make build script
• README.md — repository documentation (this file)
• VERSION - version file
• compile_flags.txt — Clangd compile options
• mkdocs.yml — MkDocs project website configuration

Project Website

As illustrated in the above diagram, information about this project is presented to users and developers in three distinct locations, each serving a specific purpose:

Location	Provides
GitHub repository	source code and project configuration
MkDocs website	detailed users guides
Doxygen documentation	detailed code reference

Author

Aaron Fu Lei

License

MIT

Version

0.3.0

Changelog

For detailed version updates, please see the CHANGELOG.