Skip to content

Commit

Permalink
Updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
datawater committed Jul 7, 2024
1 parent 68b1464 commit d20f078
Showing 1 changed file with 18 additions and 6 deletions.
24 changes: 18 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,16 @@
# CMBR

### Table Of Contents
+ [Building](#building)
+ [Usage](#usage)
+ [Documentation](#documentation)
+ [License](#license)
+ [Contributing](#contributing)
+ [Contributors](#contributors)

CMBR - Chess Move Binary Representation (WIP)

### Building
## Building
For release builds

```bash
Expand All @@ -13,7 +22,7 @@ For development builds
cargo build
```

### Usage
## Usage
For usage run
```bash
cmbrcc help
Expand All @@ -25,11 +34,14 @@ or
cargo run -- help
```

### Documentation
## Contributing
To contribute fork the repo, do your changes and submit a PR. 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 latex and [pdf](./docs/CMBR.pdf) file

### License
## License
The software is distributed under the GPL-3.0 License

### Authors
- [datawater](https://github.com/datawater)
## Contributors
- [datawater](https://github.com/datawater)

0 comments on commit d20f078

Please sign in to comment.