diff --git a/README.md b/README.md index e491e94..e6be455 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Module postgres-native-sqldelight -A native Postgres driver for SqlDelight. +A native Postgres driver for SqlDelight. - [Source code](https://github.com/hfhbd/postgres-native-sqldelight) @@ -11,7 +11,6 @@ You need `libpq` installed and available in your `$PATH`. This package is uploaded to MavenCentral and supports macOS, linuxX64. Windows is currently not supported. - ````kotlin repositories { mavenCentral() @@ -32,3 +31,29 @@ sqldelight { ## License Apache 2 + +## Contributing + +You need libpq installed: https://formulae.brew.sh/formula/libpq#default +You have to add the compiler flags to your path too. +The exact commands depend on your config, but you will get them during installing libpq with homebrew. + +Sample commands: + +``` +If you need to have libpq first in your PATH, run: + echo 'export PATH="/home/linuxbrew/.linuxbrew/opt/libpq/bin:$PATH"' >> /home/runner/.bash_profile +For compilers to find libpq you may need to set: + export LDFLAGS="-L/home/linuxbrew/.linuxbrew/opt/libpq/lib" + export CPPFLAGS="-I/home/linuxbrew/.linuxbrew/opt/libpq/include" +``` + +### Testing + +At the moment, there is a Kotlin commonizer problem with the macOS arm target. + +| Host | Supported test targets | +|-------------|-----------------------------------| +| linux x64 | linux x64 | +| macOS x64 | macOS x64, macOS arm64, linux x64 | +| macOS arm64 | macOS arm64 |