Skip to content

Commit 1127ef7

Browse files
committed
Updated README
1 parent 02fccda commit 1127ef7

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

README.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,11 @@ Presently the module is in development and the API is subject to change.
3131

3232
## Requirements
3333

34-
* A sqlite3 installation, with library and header files;
35-
* go1.17 or later
36-
* Tested on Debian Linux (32- and 64- bit) and macOS with ARM
37-
and x64 architectures.
34+
* A [sqlite3 installation](https://www.sqlite.org/capi3ref.html), with library and header files;
35+
* [go1.17](https://golang.org/dl/) or later;
36+
* [npm](https://www.npmjs.com/) in order to build the frontend;
37+
* Tested on Debian Linux (32- and 64- bit) on ARM and macOS on x64
38+
architectures.
3839

3940
## Building
4041

@@ -43,7 +44,8 @@ copy of __sqlite__ as part of the build process, but expect a `pkgconfig`
4344
file called `sqlite3.pc` to be present (and an existing set of header
4445
files and libraries to be available to link against, of course).
4546

46-
In order to locate the correct installation of `sqlite3` use two environment variables:
47+
Especially for macOS, in order to locate the correct installation of
48+
`sqlite3` use two environment variables:
4749

4850
* `PKG_CONFIG_PATH` is used for locating `sqlite3.pc`
4951
* `DYLD_LIBRARY_PATH` is used for locating the dynamic library when testing and/or running
@@ -58,6 +60,10 @@ On Macintosh with homebrew, for example:
5860
[bash] PKG_CONFIG_PATH="${SQLITE_LIB}/pkgconfig" DYLD_LIBRARY_PATH="${SQLITE_LIB}" make
5961
```
6062

63+
(You will generally want to use the `DYLD_LIBRARY_PATH` environment variable whenever you
64+
invoke an executable which embeds the sqlite dynamic library, as presently it's not statically
65+
linked into the executable)
66+
6167
On Debian Linux you shouldn't need to locate the correct path to the sqlite3 library, since
6268
only one copy is installed:
6369

0 commit comments

Comments
 (0)