Merge pull request #3223 from dolthub/aaron/update-readme-icu4c

README.md: Add notes to the readme indicating cgo dependency.

Author: reltuk

README.md

@@ -1,6 +1,6 @@
 <img height="240" src="./mascot.png"/>
 
-# A MySQL compatible database engine written in pure Go
+# A MySQL compatible database engine written in Go
 
 **go-mysql-server** is a data-source agnostic SQL engine and server
 which runs queries on data sources you provide, using the MySQL
@@ -56,6 +56,20 @@ directory with the `go.mod` file, run:
 go get github.com/dolthub/go-mysql-server@latest
 ```
 
+To implement ICU-compatible regexes, `go-mysql-server` has a dependency on
+[go-icu-regex](github.com/dolthub/go-icu-regex), which has a Cgo dependency on
+[ICU4C](https://unicode-org.github.io/icu/userguide/icu4c/). To build a project
+which depends on `go-mysql-server`, you should have a C/C++ toolchain, you
+should build with Cgo enabled, and you should have libicu-dev, or the
+equivalent for your environment, installed and available to your C++ toolchain.
+
+For convenience, `go-mysql-server` also includes a non-compatible regex
+implementation based on the Go standard library `regex.Regex`. To build against
+that, instead of the `go-icu-regex` implementation, you must compile with
+`-tags=gms_pure_go`.  Please note that some of go-mysql-server's tests do not
+pass with `-tags=gms_pure_go` and in general `gms_pure_go` is not recommended
+for users seeking MySQL compatibility.
+
 ## Using the in-memory test server
 
 The in-memory test server can replace a real MySQL server in

internal/regex/regex_pure.go

@@ -1,4 +1,4 @@
-//go:build !cgo || gms_pure_go
+//go:build gms_pure_go
 
 package regex