Skip to content

Commit

Permalink
doc: updated the README.md to include information about CGO
Browse files Browse the repository at this point in the history
  • Loading branch information
risico committed Jan 26, 2024
1 parent 9722e99 commit 927ed11
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,13 @@ queue.Prune()
queue.Vacuum()
```

# To CGO or to Not CGO
CGO is required and enabled by default as the package makes use of github.com/mattn/go-sqlite3 but if you require cross-compilation and don't want to bother with
CGO you can set the -tags nocgo (alongside CGO_ENABLED=0) and it will switch to using modernc.org/sqlite which does not require CGO.

```
go build . -tags nocgo
```

### Contributing
Feel free to contribute to this project by opening issues or submitting pull requests for bug fixes or features.
Expand Down

0 comments on commit 927ed11

Please sign in to comment.