From: drh <> Date: Wed, 1 Apr 2026 11:54:20 +0000 (+0000) Subject: Minor improvements to the documentation on how to compile for Unix. X-Git-Tag: major-release~19 X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=e230de2cbfb87f5f0955d16fc7dce596fc1a5c9f;p=thirdparty%2Fsqlite.git Minor improvements to the documentation on how to compile for Unix. No changes to code. FossilOrigin-Name: 7bc1d0c4572f126cfe68fa51fe992d2bd46b1e57c04721991bd5fad36dd795c5 --- diff --git a/README.md b/README.md index 7ec5042e5f..a1a1a7b872 100644 --- a/README.md +++ b/README.md @@ -97,6 +97,8 @@ the build products. It is recommended, but not required, that the build directory be separate from the source directory. Cd into the build directory and then from the build directory run the configure script found at the root of the source tree. Then run "make". +See the [compile-for-unix.md](doc/compile-for-unix.md) document for +more detail. For example: diff --git a/doc/compile-for-unix.md b/doc/compile-for-unix.md index 659bdb0384..e3777618c5 100644 --- a/doc/compile-for-unix.md +++ b/doc/compile-for-unix.md @@ -37,18 +37,35 @@ guidance on building for Windows. 4. Download the SQLite source tree and unpack it. CD into the toplevel directory of the source tree. - 5. Run: `./configure --enable-all --with-tclsh=$HOME/local/bin/tclsh9.0` + 5. *(Optional):* Download Antirez's "linenoise" command-line editing + library to provide command-line editing in the CLI. You can find + a suitable copy of the linenoise sources at + or at various other locations + on the internet. If you put the linenoise source tree in + a directory named $HOME/linenoise or a directory "linenoise" which + is a sibling of the SQLite source tree, then the SQLite ./configure + script will automatically find and use that source code to provide + command-line editing in the CLI. If you would rather use the readline + or editline libraries or a precompiled linenoise library, there are + ./configure options to accommodate that choice. The SQLite developers + typically use $HOME/linenoise since linenoise is small, has no + external dependencies, "just works", and the ./configure script + will pick it up and use it automatically. But you do what works + best for you. +

+ You are not required to have any command-line editing support in + order to use SQLite. But command-line editing does make the + interactive experience more enjoyable. + + 6. Run: `./configure --enable-all --with-tclsh=$HOME/local/bin/tclsh9.0` You do not need to use --with-tclsh if the tclsh you want to use is the first one on your PATH or if you are building without TCL. - The SQLite developers typically add the -   `--with-linenoise=$HOME/linenoise`   option - to provide command-line editing. "$HOME/linenoise" is a directory - that contains [linenoise](https://github.com/antirez/linenoise) source - code files, `linenoise.c` and `linenoise.h`. + Lots of other options to ./configure are available. + Run `./configure --help` for further guidance. - 6. Run the "`Makefile`" makefile with an appropriate target. + 7. Run the "`Makefile`" makefile with an appropriate target. Examples: