Skip to content

Add README.md with badges and documentation#1

Open
ghostyappzeta[bot] wants to merge 1 commit intomasterfrom
add-readme-documentation
Open

Add README.md with badges and documentation#1
ghostyappzeta[bot] wants to merge 1 commit intomasterfrom
add-readme-documentation

Conversation

@ghostyappzeta
Copy link

@ghostyappzeta ghostyappzeta bot commented Feb 25, 2026

This pull request was generated by @kiro-agent 👻

Comment with /kiro fix to address specific feedback or /kiro all to address everything.
Learn about Kiro autonomous agent


Summary

Adds a comprehensive README.md file with badges and concise documentation for the branchless library.

Changes

  • Created README.md with:
    • Badges: MIT License, C11 language, Header-only indicators
    • Features: Highlights of the library (header-only, no deps, C11, 32/64-bit support)
    • Installation: Usage instructions with the BRANCHLESS_IMPLEMENTATION pattern
    • API Reference: Tables documenting all sign and utility functions
    • Build instructions: CMake commands to build and run tests
    • References: Links to original bithacks and bit tricks sources
    • License: MIT license attribution

The old plain-text README file remains for backwards compatibility.

- Add badges for MIT license, C11, and header-only status
- Add installation instructions with BRANCHLESS_IMPLEMENTATION usage
- Add API reference tables for all functions
- Add build/test instructions for CMake
- Add references to bithacks sources
- Update LICENSE with correct author name (Alexander Zhipa) and year (2025)
@clumsy clumsy force-pushed the add-readme-documentation branch from 3efa515 to 9b361f4 Compare February 26, 2026 16:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant