Merge branch 'master' of tronto.net:nissy-core

2 files changed, 29 insertions, 20 deletions

diff --git a/README.md b/README.md
index a3c9347..3455ccd 100644
--- a/README.md
+++ b/README.md
@@ -39,8 +39,16 @@ is going to configure `nissy` to use at most 3 threads, and build it with
 
 ### Windows
 
-It is possible to build this project on Windows using `build.bat`. This script
-is going to build:
+It is possible to build this project on Windows using `build.bat`. The
+[Clang](https://clang.llvm.org/) compiler must be installed, and the
+command prompt must be correctly configured to run it.
+
+We suggest installing Clang via the Visual Studio Istaller, selecting
+the "C++ development" pack, as well as the "clang" and "Windows SDK 11"
+components. It is advised to use "x64 Native Tools Command Prompt for
+VS 2022" instead of a regular command prompt to run the build script.
+
+The `build.bat` script is going to build:
 
 * The core nissy library
 * The shell `run.exe` (see below)
diff --git a/build.sh b/build.sh
index cad6947..7cd38e3 100755
--- a/build.sh
+++ b/build.sh
@@ -170,26 +170,27 @@ fi
 build_help() {
         echo "Build system for nissy. Usage:"
         echo ""
-        echo "$0 [-d] TARGET             # build the given TARGET"
-        echo "$0 [-d]                    # same as '$0 nissy [-d]'"
-        echo "$0 test [PATTERN]          # run unit tests (matching PATTERN)"
-        echo "$0 webtest [PATTERN]       # same as test, but for WASM build"
-        echo "$0 [-d] tool PATTERN       # run the tool matching PATTERN"
+        echo "$0 [-d] [TARGET]"
         echo ""
-        echo "targets:"
+        echo "Possible values for TARGET (defaults to 'nissy' if unspecified):"
         echo ""
-        echo "nissy       Build the nissy.o object file"
-        echo "lib         Build the static library libnissy.a"
-        echo "sharedlib   Build the shared library libnissy.so"
-        echo "python      Build the Python module for nissy"
-        echo "shell       Build a basic nissy shell (./run)"
-        echo "web         Build the WebAssembly / JavaScript module for nissy"
-        echo "cpp FILES   Build and run the given FILES including cpp/nissy.h"
-        echo "solvetest   Build nissy and run the tests for solvers (tools)"
-        echo ""
-        echo "help        Show this help message"
-        echo "config      Show build configuration and exit"
-        echo "clean       Remove all build files"
+        echo "nissy          Build the nissy.o object file."
+        echo "lib            Build the static library libnissy.a."
+        echo "sharedlib      Build the shared library libnissy.so."
+        echo "python         Build the Python module for nissy."
+        echo "shell          Build a basic nissy shell (./run)."
+        echo "web            Build the WebAssembly module for nissy."
+        echo "cpp FILES      Build and run the given C++ FILES."
+        echo "test [EXPR]    Build and run unit tests. If EXPR is provided,"
+        echo "               only the tests whose name matches EXPR are run."
+        echo "               The -d option is always implied."
+        echo "webtest [EXPR] Same as test, but for WebAssembly build."
+        echo "tool EXPR      Run the 'tool' matching the given EXPR."
+        echo "solvetest      Build nissy and run a collection of tools for"
+        echo "               testing various solvers."
+        echo "help           Show this help message."
+        echo "config         Show build configuration and exit."
+        echo "clean          Remove all build files."
         echo ""
         echo "The -d option activates debug mode (slower, used for testing)."
         echo "Tests are automatically built in debug mode even without -d."