README.txt 3.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101
  1. This package contains:
  2. * the SQLite library amalgamation source code file: sqlite3.c
  3. * the sqlite3.h and sqlite3ext.h header files that define the C-language
  4. interface to the sqlite3.c library file
  5. * the shell.c file used to build the sqlite3 command-line shell program
  6. * autoconf/automake installation infrastucture for building on POSIX
  7. compliant systems
  8. * a Makefile.msc, sqlite3.rc, and Replace.cs for building with Microsoft
  9. Visual C++ on Windows
  10. WHY USE THIS PACKAGE?
  11. =====================
  12. The canonical make system for SQLite requires TCL as part of the build
  13. process. Various TCL scripts are used to generate parts of the code and
  14. TCL is used to run tests. But some people would prefer to build SQLite
  15. using only generic tools and without having to install TCL. The purpose
  16. of this package is to provide that capability.
  17. This package contains a pre-build SQLite amalgamation file "sqlite3.c"
  18. (and its associated header file "sqlite3.h"). Because the amalgamation
  19. has been pre-built, no TCL is required.
  20. REASONS TO USE THE CANONICAL BUILD SYSTEM RATHER THAN THIS PACKAGE
  21. ==================================================================
  22. * the cononical build system allows you to run tests to verify that
  23. the build worked
  24. * the canonical build system supports more compile-time options
  25. * the canonical build system works for any arbitrary check-in to
  26. the SQLite source tree
  27. Step-by-step instructions on how to build using the canonical make
  28. system for SQLite can be found at:
  29. https://sqlite.org/src/doc/trunk/doc/compile-for-unix.md
  30. https://sqlite.org/src/doc/trunk/doc/compile-for-windows.md
  31. SUMMARY OF HOW TO BUILD USING THIS PACKAGE
  32. ==========================================
  33. Unix: ./configure; make
  34. Windows: nmake /f Makefile.msc
  35. BUILDING ON POSIX
  36. =================
  37. The generic installation instructions for autoconf/automake are found
  38. in the INSTALL file.
  39. The following SQLite specific boolean options are supported:
  40. --enable-readline use readline in shell tool [default=yes]
  41. --enable-threadsafe build a thread-safe library [default=yes]
  42. --enable-dynamic-extensions support loadable extensions [default=yes]
  43. The default value for the CFLAGS variable (options passed to the C
  44. compiler) includes debugging symbols in the build, resulting in larger
  45. binaries than are necessary. Override it on the configure command
  46. line like this:
  47. $ CFLAGS="-Os" ./configure
  48. to produce a smaller installation footprint.
  49. Other SQLite compilation parameters can also be set using CFLAGS. For
  50. example:
  51. $ CFLAGS="-Os -DSQLITE_THREADSAFE=0" ./configure
  52. BUILDING WITH MICROSOFT VISUAL C++
  53. ==================================
  54. To compile for Windows using Microsoft Visual C++:
  55. $ nmake /f Makefile.msc
  56. Using Microsoft Visual C++ 2005 (or later) is recommended. Several Windows
  57. platform variants may be built by adding additional macros to the NMAKE
  58. command line.
  59. Other preprocessor defines
  60. --------------------------
  61. Additionally, preprocessor defines may be specified by using the OPTS macro
  62. on the NMAKE command line. However, not all possible preprocessor defines
  63. may be specified in this manner as some require the amalgamation to be built
  64. with them enabled (see http://www.sqlite.org/compile.html). For example, the
  65. following will work:
  66. "OPTS=-DSQLITE_ENABLE_STAT4=1 -DSQLITE_OMIT_JSON=1"
  67. However, the following will not compile unless the amalgamation was built
  68. with it enabled:
  69. "OPTS=-DSQLITE_ENABLE_UPDATE_DELETE_LIMIT=1"