JohnSanpe / bfdev-devel

bfdev is a high-performance, aesthetically pleasing, and portable infrastructure provisioning library. Its goal is to provide a comprehensive and streamlined development environment.

BFDEV Introduce

bfdev is a high-performance, aesthetically pleasing, and portable infrastructure provisioning library. Its goal is to provide a comprehensive and streamlined development environment.

Continuous Integration Status

Status (master)	Status (devel)	Description
		Build default config on Ubuntu gcc
		Build default config on Ubuntu clang
		Build default config on Macos
		Build default config on Windows
		Code analyse on codeql

Why Choose

• The library provides common data structures, eliminating the need to reinvent the wheel.
• Supports dynamic checking of data structures.
• Designed with an object-oriented approach, providing compatibility with various project.
• Offers a rich and well-organized set of APIs for users.
• Conforms to the GNUC standard, ensuring strong cross-platform compatibility.

Note

We are seeking developers to collaborate with us on improve this project.

View supported components: Docs

Directory Structure

.
├── arch
├── cmake
├── docs
├── examples
├── include
├── scripts
└── src

Directory	Description
arch	ISA related code
cmake	cmake configuration file
docs	doc for guiding
exampes	unit testing and case
include	include path
scripts	build scripts
src	core code path

Reference Path

graph LR
    include[include]
    include/asm-generic[asm-generic]
    arch/asm[asm]
    arch/asm-generated{exist}

    subgraph target[User Installation]
        include/bfdev[bfdev]
        include/bfdev/asm-generic[bfdev:asm-generic]
        arch/bfdev/asm[bfdev:asm]
        arch/bfdev/asm-generated{exist}
    end

    include --> arch/asm-generated
    arch/asm-generated --Y--> arch/asm
    arch/asm -.-> include/asm-generic
    arch/asm-generated --N--> include/asm-generic
    include/bfdev --> arch/bfdev/asm-generated
    arch/bfdev/asm-generated --Y--> arch/bfdev/asm
    arch/bfdev/asm-generated --N--> include/bfdev/asm-generic
    arch/bfdev/asm -.-> include/bfdev/asm-generic
    include --> include/bfdev
    arch/asm --> arch/bfdev/asm
    include/asm-generic --> arch/bfdev/asm

Documentation Tutorial

Quickly start, API manual, see Bfdev Documentation Tutorial

Caution

This project requires additional testing. If used in a production environment, please be aware of the associated risks.

License

This is free software: you can redistribute it and/or modify it under the terms of the latest GNU General Public License as published by the Free Software Foundation.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.