Skip to content

kalkins/rust_chess

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

44 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Chess library

This is a library that handles all the logic behind a chess game, written in Rust. The full documentation can be found here. An implementation of this library in an actual chess game can be found here.

Automatic documentation

To automatically update the documentation in the docs/ folder to show it on Github Pages, make a file .git/hooks/post-commit in the project folder and put the following content in it:

#!/bin/sh

cargo doc
cp -r target/doc/* docs/
git add docs
git commit -m "Updated docs."

exit 1

This will automatically generate and copy the documentation after each commit, as a seperate commit. When the branch is merged with master and uploaded to Github, the documentation will be available on Github Pages, if you've set it up for the project. Note that you have to put /chess/ at the end of the Github Pages URL because of how rust docs are structured.

About

A library for chess games, written in Rust

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages