AryaWu/sqlite

1This package contains:2 3 * the SQLite library amalgamation source code file: sqlite3.c4 * the sqlite3.h and sqlite3ext.h header files that define the C-language5   interface to the sqlite3.c library file6 * the shell.c file used to build the sqlite3 command-line shell program7 * autoconf-like installation infrastucture for building on POSIX8   compliant systems9 * a Makefile.msc, sqlite3.rc, and Replace.cs for building with Microsoft10   Visual C++ on Windows11 12WHY USE THIS PACKAGE?13=====================14 15The canonical make system for SQLite requires TCL as part of the build16process.  Various TCL scripts are used to generate parts of the code and17TCL is used to run tests.  But some people would prefer to build SQLite18using only generic tools and without having to install TCL.  The purpose19of this package is to provide that capability.20 21This package contains a pre-build SQLite amalgamation file "sqlite3.c"22(and its associated header file "sqlite3.h").  Because the23amalgamation has been pre-built, no TCL is required for the code24generate (the configure script itself is written in TCL but it can use25the embedded copy of JimTCL).26 27REASONS TO USE THE CANONICAL BUILD SYSTEM RATHER THAN THIS PACKAGE28==================================================================29 30 * the canonical build system allows you to run tests to verify that31   the build worked32 * the canonical build system supports more compile-time options33 * the canonical build system works for any arbitrary check-in to34   the SQLite source tree35 36Step-by-step instructions on how to build using the canonical make37system for SQLite can be found at:38 39  https://sqlite.org/src/doc/trunk/doc/compile-for-unix.md40  https://sqlite.org/src/doc/trunk/doc/compile-for-windows.md41 42 43SUMMARY OF HOW TO BUILD USING THIS PACKAGE44==========================================45 46  Unix:      ./configure; make47  Windows:   nmake /f Makefile.msc48 49BUILDING ON POSIX50=================51 52The configure script follows common conventions, making it easy53to use for anyone who has configured a software tree before.54It supports a number of build-time flags, the full list of which55can be seen by running:56 57  ./configure --help58 59The default value for the CFLAGS variable (options passed to the C60compiler) includes debugging symbols in the build, resulting in larger61binaries than are necessary. Override it on the configure command62line like this:63 64  $ CFLAGS="-Os" ./configure65 66to produce a smaller installation footprint.67 68Many SQLite compilation parameters can be defined by passing flags69to the configure script. Others may be passed on in the CFLAGS. For70example:71 72  $ CFLAGS="-Os -DSQLITE_OMIT_DEPRECATED" ./configure73 74 75BUILDING WITH MICROSOFT VISUAL C++76==================================77 78To compile for Windows using Microsoft Visual C++:79 80  $ nmake /f Makefile.msc81 82Using Microsoft Visual C++ 2005 (or later) is recommended.  Several Windows83platform variants may be built by adding additional macros to the NMAKE84command line.85 86 87Other preprocessor defines88--------------------------89 90Additionally, preprocessor defines may be specified by using the OPTS macro91on the NMAKE command line.  However, not all possible preprocessor defines92may be specified in this manner as some require the amalgamation to be built93with them enabled (see http://sqlite.org/compile.html). For example, the94following will work:95 96  "OPTS=-DSQLITE_ENABLE_STAT4=1 -DSQLITE_OMIT_JSON=1"97 98However, the following will not compile unless the amalgamation was built99with it enabled:100 101  "OPTS=-DSQLITE_ENABLE_UPDATE_DELETE_LIMIT=1"102