Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Minor fixes and additions to the readme #49

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Minor fixes and additions to the readme #49

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f0dbd58
Added help on how to find compilation help
Rodeoclash Feb 1, 2020
e30d0ba
Quoted arguments in command
Rodeoclash Feb 1, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,14 @@

Run powerful and flexible queries on **very big chessdatabases** and with **very high speed**.

## Compiling

Scoutfish needs to be compiled before use as binaries are not provided. To see help on how to compile:

cd src && make help

## Getting started

Start building an index out of a [PGN](https://en.wikipedia.org/wiki/Portable_Game_Notation) file:

./scoutfish make my_big_db.pgn
Expand All @@ -13,7 +21,7 @@ Search result will be in JSON too.

You can run Scoutfish from the command line:

./scoutfish scout my_big_db.scout { "sub-fen": "8/8/p7/8/8/1B3N2/8/8" }
./scoutfish scout my_big_db.scout "{ \"sub-fen\": \"8/8/p7/8/8/1B3N2/8/8\" }"

To find all the games that match the given **sub-fen** condition, i.e. all the
games with at least one position with a black pawn in _a6_, a white bishop in
Expand Down