From 56a048054078e316ddb057057c323116b82d8b46 Mon Sep 17 00:00:00 2001 From: drh <> Date: Fri, 6 Sep 2024 09:49:13 +0000 Subject: [PATCH] Clarification and simplification to the README.md file and to the instructions for building on Windows. FossilOrigin-Name: f69ef1a37b2778bdf73ee7e3b3edd74f7344ab8e5eedbedc22203c782e521f5b --- README.md | 27 +++++++++++++++------------ doc/compile-for-windows.md | 13 ++++++++++++- manifest | 14 +++++++------- manifest.uuid | 2 +- 4 files changed, 35 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index ad11c453ac..689b52dabd 100644 --- a/README.md +++ b/README.md @@ -73,23 +73,26 @@ archives or [SQLite archives](https://sqlite.org/cli.html#sqlar) as follows: then click on the "Tarball" or "ZIP Archive" links on the information page. -To access sources directly using Fossil, first install Fossil version 2.0 or later. -Source tarballs and precompiled binaries available -[here](https://www.fossil-scm.org/home/uv/download.html). Fossil is +To access sources directly using [Fossil](https://fossil-scm.org/home), +first install Fossil version 2.0 or later. +Source tarballs and precompiled binaries available at +. Fossil is a stand-alone program. To install, simply download or build the single executable file and put that file someplace on your $PATH. Then run commands like this: - mkdir -p ~/sqlite ~/Fossils + mkdir -p ~/sqlite cd ~/sqlite - fossil clone https://www.sqlite.org/src ~/Fossils/sqlite.fossil - fossil open ~/Fossils/sqlite.fossil + fossil open https://sqlite.org/src -After setting up a repository using the steps above, you can do -bandwidth-efficient updates to the latest version using: +The "fossil open" command will take two or three minutes. Afterwards, +you can do fast, bandwidth-efficient updates to the whatever versions +of SQLite you like. Some examples: - fossil update trunk ;# latest trunk check-in - fossil update release ;# latest official release + fossil update trunk ;# latest trunk check-in + fossil update release ;# latest official release + fossil update trunk:2024-01-01 ;# First trunk check-in after 2024-01-01 + fossil update version-3.39.0 ;# Version 3.39.0 Or type "fossil ui" to get a web-based user interface. @@ -148,7 +151,7 @@ show what changes are needed. ## Compiling for Windows Using MSVC -On Windows, all applicable build products can be compiled with MSVC. +On Windows, everything can be compiled with MSVC. You will also need a working installation of TCL. See the [compile-for-windows.md](doc/compile-for-windows.md) document for additional information about how to install MSVC and TCL and configure your @@ -383,7 +386,7 @@ implementation. It will not be the easiest library in the world to hack. * **VERSION**, **manifest**, and **manifest.uuid** - These files define the current SQLite version number. The "VERSION" file is human generated, but the "manifest" and "manifest.uuid" files are automatically generated - by the [Fossil version control system](https://fossil-scm/). + by the [Fossil version control system](https://fossil-scm.org/). There are many other source files. Each has a succinct header comment that describes its purpose and role within the larger system. diff --git a/doc/compile-for-windows.md b/doc/compile-for-windows.md index 5e6a2d1a25..1627188acd 100644 --- a/doc/compile-for-windows.md +++ b/doc/compile-for-windows.md @@ -57,11 +57,22 @@ canonical source on a new Windows 11 PC, as of 2023-11-01: + It is not required that you run the "tclextension-install" target prior to + running tests. However, the tests will run more smoothly if you do. + The version of SQLite used for the TCL extension does *not* need to + correspond to the version of SQLite under test. So you can install the + SQLite TCL extension once, and then use it to test many different versions + of SQLite. + + 7. For a debugging build of the CLI, where the ".treetrace" and ".wheretrace" commands work, add the DEBUG=3 argument to nmake. Like this: