Skip to content

Commit

Permalink
Add readme
Browse files Browse the repository at this point in the history
  • Loading branch information
gkalab committed Aug 22, 2019
1 parent 2e37bd9 commit ef5df0a
Showing 1 changed file with 27 additions and 0 deletions.
27 changes: 27 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
This Android library offers a **standardized way** for app developers to

- **provide chess engines to other chess apps**

- **use provided chess engines in other chess apps**


# Engine authors: how to provide a chess engine using this library #

* See the StockfishChessEngine directory for an example of an app which provides Stockfish to other apps

# GUI authors: how to support the open exchange format #

* Import the library. Android Studio: File - New - Import Module (select the chessEngineSupportLibrary directory)
* use something like:
```java
EngineResolver resolver = new EngineResolver(context);
List<Engine> engines = resolver.resolveEngines();
```
> engines is now a list of ChessEngines for the current target. E.g.:
```java
TextView text = findViewById(R.id.exampleText);
for (ChessEngine engine : engines) {
text.append(engine.getName() + ": " + engine.getEnginePath() + "\n");
}
```
> you can directly execute the engine from the engine path

0 comments on commit ef5df0a

Please sign in to comment.