branch: elpa/emacsql
commit c1ede49bbe5527aa49a1ea4cf19377fd212418dd
Author: Christopher Wellons <well...@nullprogram.com>
Commit: Christopher Wellons <well...@nullprogram.com>
Update headers.
---
README.md | 30 +++++++++++++++---------------
emacsql.el | 11 +++++------
2 files changed, 20 insertions(+), 21 deletions(-)
diff --git a/README.md b/README.md
index 52bdc4ddcc..49294a746e 100644
--- a/README.md
+++ b/README.md
@@ -14,12 +14,15 @@ closures. EmacSQL has no concept of "TEXT" values; it's all
just lisp
objects. The lisp object `nil` corresponds 1:1 with `NULL` in the
database.
-This package includes custom native binaries for communicating with a
-SQLite database. When linked with GNU Readline, or when run in
-Windows, the official sqlite3 command shell is incapable of correct
-interaction. If your own package depends on EmacSQL as a database it
-also means you don't have to rely on the user having particular
-software installed.
+During package installation EmacSQL will attempt to compile a custom
+native binary for communicating with a SQLite database. If this fails
+(a C compiler is not available), it will attempt to download, with
+permission, a pre-built binary when the first database connection is
+attempted. The official sqlite3 command shell is incapable of correct
+interaction when linked with GNU Readline, or when run in Windows, so
+a custom built tool is required. If your own package depends on
+EmacSQL as a database this means it doesn't have to rely on the user
+having any particular software installed.
Requires Emacs 24 or later.
@@ -278,21 +281,18 @@ This is why rows must be vectors and not lists.
## SQLite Support
-The included SQLite binary is compiled with [Soundex][soundex] and
-[full-text search][fts] (FTS4) enabled. These are disabled by the
-default SQLite build. Currently binaries are included for the
-following platforms:
+The custom EmacSQL SQLite binary is compiled with [Soundex][soundex]
+and [full-text search][fts] (FTS4) enabled -- features disabled by the
+default SQLite build. This backend should work on any system with a
+compliant C compiler installed as `cc`. If you don't have a C compiler
+installed the following platforms will be able to fetch a pre-built
+SQLite binary:
* Linux x86 and x86_64
* OS X x86_64
* Windows x86 and x86_64, including Cygwin
* Linux armv6l (Raspberry Pi + Raspbian)
-EmacSQL will run the binary matching Emacs, not necessarily the best
-one for the OS, so 32-bit Emacs will run the 32-bit back-end. More
-platforms could be supported in the future, but this is currently all
-I'm able to target and test at the moment.
-
### Ignored Features
EmacSQL doesn't cover all of SQLite's features. Here are a list of
diff --git a/emacsql.el b/emacsql.el
index c3c4183bd3..7a6857fef0 100644
--- a/emacsql.el
+++ b/emacsql.el
@@ -13,12 +13,11 @@
;; (primarily), PostgreSQL, MySQL, and potentially other SQL
;; databases.
-;; Notice: this package is bundled with custom SQLite native binaries
-;; for a number of platforms. This means you do *not* need to install
-;; any sort of SQLite software on your system for EmacSQL to work.
-;; Unless you're on an unusual platform, in which case you'll need to
-;; compile your own. This is not the case for any other SQL database,
-;; however.
+;; During package installation EmacSQL will attempt to compile a
+;; custom native binary for communicating with a SQLite database. If
+;; this fails (a C compiler is not available), it will attempt to
+;; download, with permission, a pre-built binary when the first
+;; database connection is attempted.
;; Most EmacSQL functions operate on a database connection. A
;; connection to SQLite is established with `emacsql-connect'. For
