Renamed UNIX build script to build.sh, added info to README.md related to windows build

6 files changed, 46 insertions, 34 deletions

diff --git a/README.md b/README.md
index d025f89..a3c9347 100644
--- a/README.md
+++ b/README.md
@@ -13,43 +13,55 @@ of pruning tables that were developed independently.
 
 ## Building
 
-This project currently supports only POSIX systems (Linux, MacOS, BSD...).
-If you want to build on Windows you can do so via
-[WSL](https://learn.microsoft.com/en-us/windows/wsl/install). Note that
-the resulting executable will not be a native Windows executable.
-Windows as a build target will be available in the future.
+This project is mainly developed on UNIX systems (Linux, MacOS, BSD...),
+but it is also possible to build it on Windows, with some limitations.
+
+### UNIX (Linux, MaxOS, BSD...)
 
 To build nissy simply run
 
 ```
-$ ./build
+$ ./build.sh
 ```
 
-For a list of options and targets for the build system run `./build help`.
+For a list of options and targets for the build system run `./build.sh help`.
 Some compiler settings can be overridden using environment variables,
 as explained in the comments at the beginning of the build script. For
 example, the command:
 
 ```
 $ export NISSY_BUILD_THREADS=3
-$ CC=gcc ./build
+$ CC=gcc ./build.sh
 ```
 
 is going to configure `nissy` to use at most 3 threads, and build it with
-`gcc`. Se the comments in `./build` for more details.
+`gcc`. Se the comments in `./build.sh` for more details.
+
+### Windows
+
+It is possible to build this project on Windows using `build.bat`. This script
+is going to build:
+
+* The core nissy library
+* The shell `run.exe` (see below)
+* The Python module (see below)
+
+All other options are unavailable. Moreover, Windows build will not
+enable certain optimizations, such as multithreading and advanced CPU
+instructions.  Work is ongoing to improve Windows support.
 
 ## Running tests
 
 This project includes a suite of "unit" test. You can run them with:
 
 ```
-$ ./build test
+$ ./build.sh test
 ```
 
 For running the tests for the WebAssembly build with nodejs you can use:
 
 ```
-$ ./build webtest
+$ ./build.sh webtest
 ```
 
 To run only a subset of the tests, you can pass as argument a regular
@@ -84,7 +96,7 @@ are not run in debug mode by default.
 To run a tool you can use:
 
 ```
-$ ./build tool TOOLNAME PARAMETERS...
+$ ./build.sh tool TOOLNAME PARAMETERS...
 ```
 
 Where `TOOLNAME` is the name of one of the tools, or a regular expression
@@ -94,7 +106,7 @@ parameters.
 For example:
 
 ```
-$ :./build tool gendata h48h2k2
+$ :./build.sh tool gendata h48h2k2
 ```
 
 Will run a tool that generates the data table for the H48 solver with
@@ -104,7 +116,7 @@ Each tool run is automatically timed, so these tools can be used as
 benchmark.  The output as well as the time of the run are saved to a
 file in the tools/results folder.
 
-To build and run a tool in debug mode, use `./build -d tool`.
+To build and run a tool in debug mode, use `./build.sh -d tool`.
 
 ### The `solvetest` tools
 
@@ -113,7 +125,7 @@ solvers produce the correct solutions. They can be run individually as
 all other tools, or all together with
 
 ```
-$ ./build solvetest   # Use -d for debug mode (very slow for some solvers)
+$ ./build.sh solvetest   # Use -d for debug mode (very slow for some solvers)
 ```
 
 If one of the solvetests fails, subsequent tests are going to be skipped.
@@ -127,7 +139,7 @@ as the commands require quite verbose options.
 To build the shell run:
 
 ```
-$ ./build shell
+$ ./build.sh shell
 ```
 
 This will create an executable called `run`.  Then you can for example
@@ -192,7 +204,7 @@ interface. You can build them and run them with the build tool, for
 example:
 
 ```
-./build cpp cpp/examples/solve_h48h3k2.cpp
+./build.sh cpp cpp/examples/solve_h48h3k2.cpp
 ```
 
 NOTE: If you prefer to use a C-style API, you'll have to write
@@ -207,10 +219,10 @@ this module follows the C API quite closely, except its functions
 sometimes return strings instead of writing to `char *` buffers.
 
 To build the Python module you need the Python development headers
-installed. You can check this from the output of `./build config`:
+installed. You can check this from the output of `./build.sh config`:
 
 ```
-$ ./build config
+$ ./build.sh config
 ...
 Python bindings: version 3.13
 ```
@@ -218,7 +230,7 @@ Python bindings: version 3.13
 Then to build the module:
 
 ```
-$ ./build python
+$ ./build.sh python
 ```
 
 And to import it
@@ -255,7 +267,7 @@ Bindings for JavaScript via a WebAssembly build (using
 The JavaScript module can be built with
 
 ```
-$ ./build web
+$ ./build.sh web
 ```
 
 An example web app running nissy can be found in the `web/http` folder.
diff --git a/benchmarks/benchmarks.md b/benchmarks/benchmarks.md
index 805408d..f84ddb3 100644
--- a/benchmarks/benchmarks.md
+++ b/benchmarks/benchmarks.md
@@ -234,7 +234,7 @@ Time per cube adjusted for tables size (in seconds \* GiB, lower is better).
   example:
 
 ```
-./build tool solve_file h48h7k2 ./benchmarks/scrambles/scrambles-16.txt
+./build.sh tool solve_file h48h7k2 ./benchmarks/scrambles/scrambles-16.txt
 ```
 
   To find all solutions, add something like `99999 0` at the end of the
diff --git a/build b/build.sh
index cdf0c79..cad6947 100755
--- a/build
+++ b/build.sh
@@ -1,11 +1,11 @@
 #!/bin/sh
 
-# Build system for nissy, run './build help' for info on how to use this.
+# Build system for nissy, run './build.sh help' for info on how to use this.
 
 # The variables below can be used to personalize the build system. For example,
 # to compile with clang instead of the default cc one can use:
 #
-#   CC=clang ./build
+#   CC=clang ./build.sh
 # 
 # Each variable also has a counterpart that starts with NISSY_BUILD_*. These
 # other variables can be set, for example, in your shell configuration file
@@ -20,7 +20,7 @@
 # If later the same user wants to build a debug version without sanitizers,
 # they may use
 #
-#   SANITIZE="" ./build debug
+#   SANITIZE="" ./build.sh debug
 #
 # And the empty string value will take precedence.
 
@@ -193,7 +193,7 @@ build_help() {
         echo ""
         echo "The -d option activates debug mode (slower, used for testing)."
         echo "Tests are automatically built in debug mode even without -d."
-        echo "For more on build configurations, see the comments in ./build"
+        echo "For more on build configurations, see the comments in ./build.sh"
 }
 
 build_config() {
@@ -287,7 +287,7 @@ build_cpp() {
         validate_command "$CXX"
         if [ -z "$@" ]; then
                 echo "Please provide one or more valid C++ source files"
-                echo "usage: ./build cpp FILES"
+                echo "usage: ./build.sh cpp FILES"
         fi
 
         build_nissy || exit 1
@@ -418,7 +418,7 @@ build_tool() {
 
         if [ -z "$pattern" ]; then
                 echo "Please provide a valid PATTERN to select a tool"
-                echo "usage: ./build tool PATTERN"
+                echo "usage: ./build.sh tool PATTERN"
                 exit 1
         fi
         shift
diff --git a/python/examples/solve.py b/python/examples/solve.py
index 725c704..75e7914 100644
--- a/python/examples/solve.py
+++ b/python/examples/solve.py
@@ -1,6 +1,6 @@
 # Small example of nissy Python module usage
 
-# Run "./build python", then run this from either the top-level directory
+# Run "./build.sh python", then run this from either the top-level directory
 # of the nissy-core repo or from the python subdirectory.
 
 # Append the directories to the python path so we can load the module
diff --git a/utils/container-run.sh b/utils/container-run.sh
index ba8deae..6090e1c 100755
--- a/utils/container-run.sh
+++ b/utils/container-run.sh
@@ -4,14 +4,14 @@
 # It can be used for testing on platforms different from the host. For example,
 # the command
 # 
-# ./container-run.sh arm ./build test
+# ./container-run.sh arm ./build.sh test
 #
 # builds nissy and runs the unit tests in an ARM container.
 #
 # The containers are based on Alpine Linux and the contain the necessary tools
 # to build the main library and the C++ and Python examples. They DO NOT
 # contain the emscripten compiler, so they cannot be used to build the web
-# version (e.g. ./build web or ./buidl webtest).
+# version (e.g. ./build.sh web or ./build.sh webtest).
 # The images are given a tag starting with 'localhost/nissy/'.
 #
 # See below for a list of options.
@@ -28,7 +28,7 @@ usage() {
         echo "arm   (equivalent to: arm64)"
         echo ""
         echo "Examples:"
-        echo "$0 ram ./build test   # Run unit tests in arm container"
+        echo "$0 ram ./build.sh test   # Run unit tests in arm container"
         exit 1
 }
 
diff --git a/web/http/nissyapp.mjs b/web/http/nissyapp.mjs
index b056b5f..a653db6 100644
--- a/web/http/nissyapp.mjs
+++ b/web/http/nissyapp.mjs
@@ -1,6 +1,6 @@
-// Run ./build web from the main folder before running this example.
+// Run ./build.sh web from the main folder before running this example.
 // The necessary modules (including worker.mjs) will be built and / or moved
-// to this folder when running ./build web.
+// to this folder when running ./build.sh web.
 
 var solveButton = document.getElementById("solveButton");
 var pauseResumeButton = document.getElementById("pauseResumeButton");