README.md

CMBR

Table Of Contents

• Building
• Usage
• Documentation
• License
• Contributing
• Contributors

CMBR - Chess Move Binary Representation (WIP)

Building

For release builds

cargo build --release

For development builds

cargo build

Usage

For usage run

cmbrcc help

or

cargo run -- help

Contributing

To contribute fork the repo, do your changes and submit a PR. Make sure that your PR passes make check. View issues tagged with "good first issue" for stuff to-do. If your PR tries to tackle with performance, please include a simple benchmark/profile, showing your results.

Documentation

The documentation (WIP/Unfinished) is provided as a markdown file

License

The software is distributed under the GPL-3.0 License

Contributors

• datawater