Skip to content

README.md

Latest commit

 

History

History
70 lines (52 loc) · 3.6 KB

README.md

File metadata and controls

70 lines (52 loc) · 3.6 KB

Badge Documentation

This section explains the status badges shown at the top of the ThemisDB README.

The README header is organised into four thematic rows for quick scanning. Each badge links back to the corresponding page in this directory for more detail.

Badges

Row 1 – Build & Release

Badge What it shows Details
CI Status Latest build result (Themis Core CI) ci-status.md
Security CI Latest security hardening CI result security-ci.md
Version/Release Current release tag version.md
License Project license (MIT) license.md
Docker Pulls Total Docker Hub pulls for themisdb/themisdb docker.md

Row 1b – Edition CI

Badge What it shows Details
MINIMAL Latest MINIMAL edition CI result on develop edition-ci.md
COMMUNITY Latest COMMUNITY edition CI result on develop edition-ci.md
ENTERPRISE Latest ENTERPRISE edition CI result on develop edition-ci.md
HYPERSCALER Latest HYPERSCALER edition CI result on develop edition-ci.md
MILITARY Latest MILITARY edition CI result on develop edition-ci.md

Row 2 – Code Metrics

Badge What it shows Details
Lines of Code Total source lines (Tokei count, stored in .github/badges/lines-of-code.json) loc.md
Repo Size Total repository size (GitHub API) repo-size.md
Last Commit Date of the most recent commit on develop last-commit.md
Stars GitHub star count stars.md
Forks GitHub fork count forks.md

Row 3 – Community

Badge What it shows Details
Open Issues Number of currently open GitHub Issues issues.md
Contributors Number of unique commit authors contributors.md
Docs Link to the GitHub Pages documentation site docs-site.md
pre-commit Indicates pre-commit hooks are configured pre-commit.md
PRs Welcome Community contribution signal prs-welcome.md

Row 4 – Tech Stack

Badge What it shows Details
C++20 C++ language standard used cpp-standard.md
Docker Image Size Compressed size of the latest Docker image docker-image-size.md
GPU CI Latest GPU module CI gate result gpu-ci.md
LLM CI Latest LLM CPU-fallback CI result llm-ci.md
Platform Supported operating systems platform.md

Design rationale

The badge bar uses five rows of five badges each (~25 total) to provide comprehensive project status at a glance without scrolling:

  • Row 1 answers: Is the build healthy? What version is this? Can I use it freely?
  • Row 1b answers: Do all ThemisDB editions (MINIMAL/COMMUNITY/ENTERPRISE/HYPERSCALER/MILITARY) build successfully on develop?
  • Row 2 answers: How active is development? How large is the codebase?
  • Row 3 answers: Is this project maintained and welcoming? Where are the docs?
  • Row 4 answers: What technology does this use? Does GPU/LLM support work?

Capability details (supported models, performance numbers, module documentation) are in the README body and module READMEs linked from there.