Skip to content

Commit

Permalink
Update README to add building instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
JasonCreighton committed Jan 12, 2018
1 parent ce40018 commit 5eafba0
Showing 1 changed file with 19 additions and 2 deletions.
21 changes: 19 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,28 @@ Snowy is a UCI chess engine written in C++. It uses an array-based board
representation (ie, not bitboard), and searches in a straightforward minimax
manner, with no depth extensions or reductions. The playing strength has not
been precisely evaluated, but it is somewhere between
[TSCP](http://www.tckerrigan.com/Chess/TSCP/) and
[faile](http://faile.sourceforge.net/).
[faile](http://faile.sourceforge.net/) and
[Vice](http://bluefever.net/Downloads/ViceReadMe.html).

It is available under the terms of the MIT license.

## Building

On Linux, you can build and run with:

```
$ make
$ ./build/release
```

Other UNIX-like systems with GNU Make may work, but have not been tested.

The default is to build with Clang, if you wish to use GCC you can build with:

```
$ make CXX=g++
```

## Acknowledgements

This engine would not have been possible without the knowledge freely shared by
Expand Down

0 comments on commit 5eafba0

Please sign in to comment.