Skip to content

Commit 33d1684

Browse files
committed
README.md: Add notes to the readme indicating cgo dependency.
1 parent 60a7f34 commit 33d1684

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<img height="240" src="./mascot.png"/>
22

3-
# A MySQL compatible database engine written in pure Go
3+
# A MySQL compatible database engine written in Go
44

55
**go-mysql-server** is a data-source agnostic SQL engine and server
66
which runs queries on data sources you provide, using the MySQL
@@ -56,6 +56,13 @@ directory with the `go.mod` file, run:
5656
go get github.com/dolthub/go-mysql-server@latest
5757
```
5858

59+
To implement ICU-compatible regexes, `go-mysql-server` has a dependency on
60+
[go-icu-regex](github.com/dolthub/go-icu-regex), which has a cgo dependency on
61+
[ICU4C](https://unicode-org.github.io/icu/userguide/icu4c/). To build a project
62+
which depends on `go-mysql-server`, you should have a C/C++ toolchain, you
63+
should build with Cgo enabled, and you should have libicu-dev, or the
64+
equivalent for your environment, installed and available to your C++ toolchain.
65+
5966
## Using the in-memory test server
6067

6168
The in-memory test server can replace a real MySQL server in

0 commit comments

Comments
 (0)