Skip to content

Commit 2c2fd5c

Browse files
authored
Merge pull request #49 from codeguru42/1-readme
1 readme
2 parents 94d5032 + ff1f493 commit 2c2fd5c

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Go Capture API
2+
3+
![Build](https://github.com/codeguru42/go-capture-api/actions/workflows/build.yaml/badge.svg)
4+
5+
Go Capture API is a REST API that will generate an SGF file from an image of a Go position.
6+
7+
## Requirements
8+
9+
* Python 3.11+
10+
* Docker and Docker Compose
11+
12+
## Run
13+
14+
```shell
15+
docker compose -f docker-compose-dev.yml -p go-capture-api up -d --build
16+
```

0 commit comments

Comments
 (0)