Skip to content

Commit 981be68

Browse files
committed
README
1 parent c43c599 commit 981be68

File tree

1 file changed

+84
-89
lines changed

1 file changed

+84
-89
lines changed

README.md

Lines changed: 84 additions & 89 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,13 @@
11

2-
Cinnamon
3-
==========
2+
3+
Cinnamon
4+
==========
45
### UCI Chess Engine
5-
6-
Cinnamon is a chess program for Windows, Linux, Mac OS, Android and Raspberry Pi, is a console-based chess engine for use with
7-
[xboard][4],
8-
[Arena][5],
9-
[Tarrasch][6],
10-
[Chess for Android][7]
11-
or any UCI-compatible GUI. Cinnamon is also a javascript library to play with
12-
[chessboardjs][8] or any js GUI.
13-
14-
Version
15-
----------
6+
7+
Cinnamon is a chess program for Windows, Linux, Mac OS, Android and Raspberry Pi, is a console-based chess engine for use with [xboard][4], [Arena][5], [Tarrasch][6], [Chess for Android][7] or any UCI-compatible GUI. Cinnamon is also a javascript library to play with [chessboardjs][8] or any js GUI.
8+
9+
Version
10+
----------
1611
2.2a
1712

1813
News
@@ -21,43 +16,43 @@ News
2116
- Bugs fixed in Uci protocol
2217
- Improved eval function
2318
- Improved null moves
24-
25-
Features
26-
----------
27-
28-
- Available for both Unix, Windows, Mac, Android, ARM and Javascript
29-
- UCI protocol
30-
- GPL 3 License
31-
- C++11 source
32-
- Rotated bitboards
33-
- Null moves
34-
- Futility pruning
35-
- Delta pruning
36-
- Razoring
37-
- Interruptible multithread Perft test
38-
- 32/64 bit architectures
39-
- Iterative deeping
19+
20+
Features
21+
----------
22+
23+
- Available for both Unix, Windows, Mac, Android, ARM and Javascript
24+
- UCI protocol
25+
- GPL 3 License
26+
- C++11 source
27+
- Rotated bitboards
28+
- Null moves
29+
- Futility pruning
30+
- Delta pruning
31+
- Razoring
32+
- Interruptible multithread Perft test
33+
- 32/64 bit architectures
34+
- Iterative deeping
4035
- History heuristics
41-
- Lazy evaluation
42-
- Mvv/Lva
43-
- Transposition Table
44-
- Aspiration Windows
45-
- Late Move Reduction
46-
- Ponder
47-
- Available with Tarrasch GUI for Windows
48-
- Open Book (Polyglot)
49-
- Gaviota Tablebases
50-
- [Elo ratings][3]
51-
52-
Binaries
53-
----------
54-
55-
Binaries are available [here][1].
56-
All files are compiled statically, no further libraries are necessary.
57-
58-
Command line tools
59-
----------
60-
#### Perft
36+
- Lazy evaluation
37+
- Mvv/Lva
38+
- Transposition Table
39+
- Aspiration Windows
40+
- Late Move Reduction
41+
- Ponder
42+
- Available with Tarrasch GUI for Windows
43+
- Open Book (Polyglot)
44+
- Gaviota Tablebases
45+
- [Elo ratings][3]
46+
47+
Binaries
48+
----------
49+
50+
Binaries are available [here][1].
51+
All files are compiled statically, no further libraries are necessary.
52+
53+
Command line tools
54+
----------
55+
#### Perft
6156
`cinnamon -perft [-d depth] [-c nCpu] [-h hash size (mb) [-F dump file]] [-f "fen position"] `
6257

6358
Setting dump file (-F) you can stop and start the perft process.
@@ -70,43 +65,43 @@ Setting dump file (-F) you can stop and start the perft process.
7065
`cinnamon -puzzle_epd -t K..K..`
7166
example: `cinnamon -puzzle_epd -t KRKP`
7267

73-
Compiling
74-
---------
75-
76-
Cinnamon requires C++11 or greater, use unique Makefile to compile for many architectures:
77-
78-
$ make
79-
80-
Makefile for cross-compile Linux/Windows/OSX/Raspberry
81-
82-
make cinnamon64-modern-INTEL > 64-bit optimized for modern Intel cpu
83-
make cinnamon64-modern-AMD > 64-bit optimized for modern Amd cpu
84-
make cinnamon64-modern > 64-bit with popcnt bsf sse3 support
85-
make cinnamon64-generic > Unspecified 64-bit
86-
make cinnamon64-ARM > Optimized for ARM cpu
87-
88-
make cinnamon32-modern > 32-bit with sse support
89-
make cinnamon32-generic > Unspecified 32-bit
90-
make cinnamon32-ARM > Optimized for ARM cpu
91-
92-
g++ is the default compiler, add COMP=yourcompiler to use another compiler
93-
example: make cinnamon64-modern-INTEL COMP=clang++
94-
95-
96-
License
97-
-------
98-
99-
Cinnamon is released under the GPLv3+ license.
100-
101-
Credits
102-
-------
103-
104-
Cinnamon was written by Giuseppe Cannella at gmail dot com.
105-
106-
[1]: http://cinnamonchess.altervista.org
107-
[3]: http://www.computerchess.org.uk/ccrl/404/cgi/compare_engines.cgi?family=Cinnamon
108-
[4]: http://www.gnu.org/software/xboard
109-
[5]: http://www.playwitharena.com
110-
[6]: http://triplehappy.com
111-
[7]: https://play.google.com/store/apps/details?id=com.google.android.chess
112-
[8]: http://chessboardjs.com
68+
Compiling
69+
---------
70+
71+
Cinnamon requires C++11 or greater, use unique Makefile to compile for many architectures:
72+
73+
$ make
74+
75+
Makefile for cross-compile Linux/Windows/OSX/Raspberry
76+
77+
make cinnamon64-modern-INTEL > 64-bit optimized for modern Intel cpu
78+
make cinnamon64-modern-AMD > 64-bit optimized for modern Amd cpu
79+
make cinnamon64-modern > 64-bit with popcnt bsf sse3 support
80+
make cinnamon64-generic > Unspecified 64-bit
81+
make cinnamon64-ARM > Optimized for ARM cpu
82+
83+
make cinnamon32-modern > 32-bit with sse support
84+
make cinnamon32-generic > Unspecified 32-bit
85+
make cinnamon32-ARM > Optimized for ARM cpu
86+
87+
g++ is the default compiler, add COMP=yourcompiler to use another compiler
88+
example: make cinnamon64-modern-INTEL COMP=clang++
89+
90+
91+
License
92+
-------
93+
94+
Cinnamon is released under the GPLv3+ license.
95+
96+
Credits
97+
-------
98+
99+
Cinnamon was written by Giuseppe Cannella at gmail dot com.
100+
101+
[1]: http://cinnamonchess.altervista.org
102+
[3]: http://www.computerchess.org.uk/ccrl/404/cgi/compare_engines.cgi?family=Cinnamon
103+
[4]: http://www.gnu.org/software/xboard
104+
[5]: http://www.playwitharena.com
105+
[6]: http://triplehappy.com
106+
[7]: https://play.google.com/store/apps/details?id=com.google.android.chess
107+
[8]: http://chessboardjs.com

0 commit comments

Comments
 (0)