Skip to content

KennethTrecy/abstract_chearmyp_boundary

Repository files navigation

Library Tests GitHub lines GitHub release (latest SemVer) GitHub closed issues count GitHub pull request count Commits since latest version Lines of code GitHub code size in bytes

Abstract Chearmyp Boundary

An abstraction of address boundaries on a source. Initially intended to work with Abstract Chearmyp Source but it can be used to other applications/packages as well.

Installation

Add it to the dependencies:

[dependencies.abstract_chearmyp_boundary]
git = "https://github.com/KennethTrecy/abstract_chearmyp_boundary"
tag = "v1.0.0"

You may also activate all the features:

[dependencies.abstract_chearmyp_boundary]
git = "https://github.com/KennethTrecy/abstract_chearmyp_boundary"
tag = "v1.0.0"
features = ["no_std", "range_boundary", "vec_boundary_collection"]

Origin

Some parts of the repository was based from filled_bare_metal branch of Feo Template.

Usage

Documentation

Run the following on the console:

cargo doc --all-features --open

Initialization

If you want to contribute, this repository should be initialized to adhere in Conventional Commits specification for organize commits and automated generation of change log.

Prerequisites

Instructions

By running the command below, all your commits will be linted to follow the Conventional Commits specification.

$ npm install

Or if you have installed pnpm, run the following command:

$ pnpm install

To generate the change log automatically, run the command below:

$ npx changelogen --from=[tag name or branch name or commit itself] --to=master

Notes

License

The repository is licensed under MIT.

Want to contribute?

Read the contributing guide for different ways to contribute in the project.

Author

Abstract Chearmyp Boundary was created by Kenneth Trecy Tobias.