halide 19.0.0__cp38-cp38-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl

halide/share/doc/Halide/LICENSE.txt

@@ -0,0 +1,233 @@
+Copyright (c) 2012-2020 MIT CSAIL, Google, Facebook, Adobe, NVIDIA CORPORATION, and other contributors.
+
+Developed by:
+
+  The Halide team
+  http://halide-lang.org
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+-----
+
+apps/bgu is Copyright 2016 Google Inc. and is Licensed under the Apache License,
+Version 2.0 (the "License"); you may not use this file except in compliance
+with the License.
+
+Apache License
+
+Version 2.0, January 2004
+
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction, and
+distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by the
+copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all other
+entities that control, are controlled by, or are under common control with
+that entity. For the purposes of this definition, "control" means (i) the
+power, direct or indirect, to cause the direction or management of such
+entity, whether by contract or otherwise, or (ii) ownership of fifty percent
+(50%) or more of the outstanding shares, or (iii) beneficial ownership of such
+entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising
+permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications,
+including but not limited to software source code, documentation source, and
+configuration files.
+
+"Object" form shall mean any form resulting from mechanical transformation or
+translation of a Source form, including but not limited to compiled object
+code, generated documentation, and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or Object form,
+made available under the License, as indicated by a copyright notice that is
+included in or attached to the work (an example is provided in the Appendix
+below).
+
+"Derivative Works" shall mean any work, whether in Source or Object form, that
+is based on (or derived from) the Work and for which the editorial revisions,
+annotations, elaborations, or other modifications represent, as a whole, an
+original work of authorship. For the purposes of this License, Derivative
+Works shall not include works that remain separable from, or merely link (or
+bind by name) to the interfaces of, the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including the original
+version of the Work and any modifications or additions to that Work or
+Derivative Works thereof, that is intentionally submitted to Licensor for
+inclusion in the Work by the copyright owner or by an individual or Legal
+Entity authorized to submit on behalf of the copyright owner. For the purposes
+of this definition, "submitted" means any form of electronic, verbal, or
+written communication sent to the Licensor or its representatives, including
+but not limited to communication on electronic mailing lists, source code
+control systems, and issue tracking systems that are managed by, or on behalf
+of, the Licensor for the purpose of discussing and improving the Work, but
+excluding communication that is conspicuously marked or otherwise designated
+in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity on behalf
+of whom a Contribution has been received by Licensor and subsequently
+incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:
+
+(a) You must give any other recipients of the Work or Derivative Works a copy
+of this License; and
+
+(b) You must cause any modified files to carry prominent notices stating that
+You changed the files; and
+
+(c) You must retain, in the Source form of any Derivative Works that You
+distribute, all copyright, patent, trademark, and attribution notices from the
+Source form of the Work, excluding those notices that do not pertain to any
+part of the Derivative Works; and
+
+(d) If the Work includes a "NOTICE" text file as part of its distribution,
+then any Derivative Works that You distribute must include a readable copy of
+the attribution notices contained within such NOTICE file, excluding those
+notices that do not pertain to any part of the Derivative Works, in at least
+one of the following places: within a NOTICE text file distributed as part of
+the Derivative Works; within the Source form or documentation, if provided
+along with the Derivative Works; or, within a display generated by the
+Derivative Works, if and wherever such third-party notices normally appear.
+The contents of the NOTICE file are for informational purposes only and do not
+modify the License. You may add Your own attribution notices within Derivative
+Works that You distribute, alongside or as an addendum to the NOTICE text from
+the Work, provided that such additional attribution notices cannot be
+construed as modifying the License.
+
+You may add Your own copyright statement to Your modifications and may provide
+additional or different license terms and conditions for use, reproduction, or
+distribution of Your modifications, or for any such Derivative Works as a
+whole, provided Your use, reproduction, and distribution of the Work otherwise
+complies with the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+-----
+
+apps/support/cmdline.h is Copyright (c) 2009, Hideyuki Tanaka and is licensed
+under the BSD 3-Clause license.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+* Redistributions of source code must retain the above copyright
+notice, this list of conditions and the following disclaimer.
+* Redistributions in binary form must reproduce the above copyright
+notice, this list of conditions and the following disclaimer in the
+documentation and/or other materials provided with the distribution.
+* Neither the name of the <organization> nor the
+names of its contributors may be used to endorse or promote products
+derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY <copyright holder> ''AS IS'' AND ANY
+EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL <copyright holder> BE LIABLE FOR ANY
+DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+----
+
+dependencies/spirv is Copyright (c) 2014-2018 The Khronos Group Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and/or associated documentation files (the "Materials"),
+to deal in the Materials without restriction, including without limitation
+the rights to use, copy, modify, merge, publish, distribute, sublicense,
+and/or sell copies of the Materials, and to permit persons to whom the
+Materials are furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Materials.
+
+MODIFICATIONS TO THIS FILE MAY MEAN IT NO LONGER ACCURATELY REFLECTS KHRONOS
+STANDARDS. THE UNMODIFIED, NORMATIVE VERSIONS OF KHRONOS SPECIFICATIONS AND
+HEADER INFORMATION ARE LOCATED AT https://www.khronos.org/registry/
+
+THE MATERIALS ARE PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM,OUT OF OR IN CONNECTION WITH THE MATERIALS OR THE USE OR OTHER DEALINGS
+IN THE MATERIALS.
+
+
+----
+
+dependencies/vulkan is Copyright (c) 2014-2017 The Khronos Group Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+----
+
+apps/linear_algebra/include/cblas.h is licensed under the BLAS license.
+
+The reference BLAS is a freely-available software package. It is available from
+netlib via anonymous ftp and the World Wide Web. Thus, it can be included in
+commercial software packages (and has been). We only ask that proper credit be
+given to the authors.
+
+Like all software, it is copyrighted. It is not trademarked, but we do ask the
+following:
+
+If you modify the source for these routines we ask that you change the name of
+the routine and comment the changes made to the original.
+
+We will gladly answer any questions regarding the software. If a modification is
+done, however, it is the responsibility of the person who modified the routine
+to provide support.
+

halide/share/doc/Halide/README.md

@@ -0,0 +1,439 @@
+# Halide
+
+Halide is a programming language designed to make it easier to write
+high-performance image and array processing code on modern machines. Halide
+currently targets:
+
+- CPU architectures: X86, ARM, Hexagon, PowerPC, RISC-V
+- Operating systems: Linux, Windows, macOS, Android, iOS, Qualcomm QuRT
+- GPU Compute APIs: CUDA, OpenCL, Apple Metal, Microsoft Direct X 12, Vulkan
+
+Rather than being a standalone programming language, Halide is embedded in C++.
+This means you write C++ code that builds an in-memory representation of a
+Halide pipeline using Halide's C++ API. You can then compile this representation
+to an object file, or JIT-compile it and run it in the same process. Halide also
+provides a Python binding that provides full support for writing Halide embedded
+in Python without C++.
+
+Halide requires C++17 (or later) to use.
+
+For more detail about what Halide is, see https://halide-lang.org.
+
+For API documentation see https://halide-lang.org/docs.
+
+For some example code, read through the tutorials online
+at https://halide-lang.org/tutorials. The corresponding code is in the
+`tutorials/` directory. Larger examples are in the `apps/` directory.
+
+If you've acquired a full source distribution and want to build Halide, see the
+[notes below](#building-halide).
+
+# Getting Halide
+
+## Pip
+
+As of Halide 19.0.0, we provide binary wheels on PyPI. Halide provides bindings
+for C++ and Python. Even if you only intend to use Halide from C++, pip may be
+the easiest way to get a binary build of Halide.
+
+Full releases may be installed with `pip` like so:
+
+```shell
+$ pip install halide
+```
+
+Every commit to `main` is published to Test PyPI as a development version and
+these may be installed with a few extra flags:
+
+```shell
+$ pip install halide --pre --extra-index-url https://test.pypi.org/simple
+```
+
+Currently, we provide wheels for: Windows x86-64, macOS x86-64, macOS arm64, and
+Linux x86-64. The Linux wheels are built for manylinux_2_28, which makes them
+broadly compatible (Debian 10, Ubuntu 18.10, Fedora 29).
+
+*For C++ usage of the pip package:* On Linux and macOS, CMake's `find_package`
+command should find Halide as long as you're in the same virtual environment you
+installed it in. On Windows, you will need to add the virtual environment root
+directory to `CMAKE_PREFIX_PATH`. This can be done by running
+`set CMAKE_PREFIX_PATH=%VIRTUAL_ENV%` in `cmd`.
+
+Other build systems can find the Halide root path by running `python -c 
+"import halide; print(halide.install_dir())"`.
+
+## Homebrew
+
+Alternatively, if you use macOS, you can install Halide via
+[Homebrew](https://brew.sh/) like so:
+
+```
+$ brew install halide
+```
+
+## Binary tarballs
+
+The latest version of Halide can always be found on GitHub
+at https://github.com/halide/Halide/releases
+
+We provide binary releases for many popular platforms and architectures,
+including 32/64-bit x86 Windows, 64-bit x86/ARM macOS, and 32/64-bit x86/ARM
+Ubuntu Linux.
+
+The macOS releases are built using XCode's command-line tools with Apple Clang
+500.2.76. This means that we link against libc++ instead of libstdc++. You may
+need to adjust compiler options accordingly if you're using an older XCode which
+does not default to libc++.
+
+We use a recent Ubuntu LTS to build the Linux releases; if your distribution is
+too old, it might not have the requisite glibc. 
+
+Nightly builds of Halide and the LLVM versions we use in CI are also available
+at https://buildbot.halide-lang.org/
+
+## Vcpkg
+
+If you use [vcpkg](https://github.com/microsoft/vcpkg) to manage dependencies,
+you can install Halide via:
+
+```
+$ vcpkg install halide:x64-windows # or x64-linux/x64-osx
+```
+
+One caveat: vcpkg installs only the minimum Halide backends required to compile
+code for the active platform. If you want to include all the backends, you
+should install `halide[target-all]:x64-windows` instead. Note that since this
+will build LLVM, it will take a _lot_ of disk space (up to 100GB).
+
+## Other package managers
+
+We are interested in bringing Halide to other popular package managers and Linux
+distribution repositories! We track the status of various distributions of
+Halide [in this GitHub issue](https://github.com/halide/Halide/issues/4660). If
+you have experience publishing packages we would be happy to work with you!
+
+# Building Halide
+
+## Platform Support
+
+There are two sets of platform requirements relevant to Halide: those required
+to run the compiler library in either JIT or AOT mode, and those required to run
+the _binary outputs_ of the AOT compiler.
+
+These are the **tested** host toolchain and platform combinations for building
+and running the Halide compiler library.
+
+| Compiler   | Version      | OS                     | Architectures |
+|------------|--------------|------------------------|---------------|
+| GCC        | 9.5          | Ubuntu Linux 20.04 LTS | x86, x64      |
+| GCC        | 11.4         | Ubuntu Linux 22.04 LTS | ARM32, ARM64  |
+| MSVC       | 2022 (19.37) | Windows 11 (22631)     | x86, x64      |
+| AppleClang | 15.0.0       | macOS 14.4.1           | x64           |
+| AppleClang | 14.0.0       | macOS 14.6             | ARM64         |
+
+Some users have successfully built Halide for Linux using Clang 9.0.0+, for
+Windows using ClangCL 11.0.0+, and for Windows ARM64 by cross-compiling with
+MSVC. We do not actively test these scenarios, however, so your mileage may
+vary.
+
+Beyond these, we are willing to support (by accepting PRs for) platform and
+toolchain combinations that still receive _active, first-party, public support_
+from their original vendors. For instance, at time of writing, this excludes
+Windows 7 and includes Ubuntu 18.04 LTS.
+
+Compiled AOT pipelines are expected to have much broader platform support. The
+binaries use the C ABI, and we expect any compliant C compiler to be able to use
+the generated headers correctly. The C++ bindings currently require C++17. If
+you discover a compatibility problem with a generated pipeline, please open an
+issue.
+
+## Acquiring LLVM
+
+At any point in time, building Halide requires either the latest stable version
+of LLVM, the previous stable version of LLVM, or trunk. At the time of writing,
+this means versions 19, 18, and 17 are supported, but 16 is not.
+
+It is simplest to get a binary release of LLVM on macOS by using
+[Homebrew](https://brew.sh). Just run `brew install llvm`. On Debian flavors of
+Linux, the [LLVM APT repo](https://apt.llvm.org) is best; use the provided
+installation script. We know of no suitable official binary releases for
+Windows, however the ones we use in CI can usually be found at
+https://buildbot.halide-lang.org, along with tarballs for our other tested
+platforms. See [the section on Windows](#windows) below for further advice.
+
+If your OS does not have packages for LLVM, or you want more control over the
+configuration, you can build it yourself. First check it out from GitHub:
+
+```shell
+$ git clone --depth 1 --branch llvmorg-18.1.8 https://github.com/llvm/llvm-project.git
+```
+
+(LLVM 18.1.8 is the most recent released LLVM at the time of writing. For
+current trunk, use `main` instead)
+
+Then build it like so:
+
+```shell
+$ cmake -G Ninja -S llvm-project/llvm -B build \
+        -DCMAKE_BUILD_TYPE=Release \
+        -DLLVM_ENABLE_PROJECTS="clang;lld;clang-tools-extra" \
+        -DLLVM_ENABLE_RUNTIMES=compiler-rt \
+        -DLLVM_TARGETS_TO_BUILD="WebAssembly;X86;AArch64;ARM;Hexagon;NVPTX;PowerPC;RISCV" \
+        -DLLVM_ENABLE_ASSERTIONS=ON \
+        -DLLVM_ENABLE_EH=ON \
+        -DLLVM_ENABLE_RTTI=ON \
+        -DLLVM_ENABLE_HTTPLIB=OFF \
+        -DLLVM_ENABLE_LIBEDIT=OFF \
+        -DLLVM_ENABLE_LIBXML2=OFF \
+        -DLLVM_ENABLE_TERMINFO=OFF \
+        -DLLVM_ENABLE_ZLIB=OFF \
+        -DLLVM_ENABLE_ZSTD=OFF \
+        -DLLVM_BUILD_32_BITS=OFF
+$ cmake --build build
+$ cmake --install build --prefix llvm-install
+```
+
+This will produce a working LLVM installation in `$PWD/llvm-install`. We refer
+to this path as `LLVM_ROOT` later. **Do not confuse this installation tree with
+the build tree!**
+
+LLVM takes a long time to build, so the above command uses Ninja to maximize
+parallelism. If you choose to omit `-G Ninja`, Makefiles will be generated
+instead. In this case, enable parallelism with `cmake --build build -j NNN`
+where `NNN` is the number of parallel jobs, i.e. the number of CPUs you have.
+
+Note that you _must_ add `clang` and `lld` to `LLVM_ENABLE_PROJECTS` and
+`WebAssembly` and `X86` _must_ be included in `LLVM_TARGETS_TO_BUILD`.
+`LLVM_ENABLE_RUNTIMES=compiler-rt` is only required to build the fuzz tests, and
+`clang-tools-extra` is only necessary if you plan to contribute code to Halide
+(so that you can run `clang-tidy` on your pull requests). You can disable
+exception handling (EH) and RTTI if you don't want the Python bindings. We
+recommend enabling the full set to simplify builds during development.
+
+## Building Halide with CMake
+
+This is discussed in greater detail in [BuildingHalideWithCMake.md]. CMake
+version 3.28+ is required to build Halide.
+
+[BuildingHalideWithCMake.md]: doc/BuildingHalideWithCMake.md
+
+### MacOS and Linux
+
+Follow the above instructions to build LLVM or acquire a suitable binary
+release. Then change directory to the Halide repository and run:
+
+```shell
+$ cmake -G Ninja  -S . -B build -DCMAKE_BUILD_TYPE=Release -DHalide_LLVM_ROOT=$LLVM_ROOT
+$ cmake --build build
+```
+
+Setting `-DHalide_LLVM_ROOT` is not required if you have a suitable system-wide
+version installed. However, if you have multiple LLVMs installed, it can pick
+between them.
+
+### Windows
+
+We suggest building with Visual Studio 2022. Your mileage may vary with earlier
+versions. Be sure to install the "C++ CMake tools for Windows" in the Visual
+Studio installer. For older versions of Visual Studio, do not install the CMake
+tools, but instead acquire CMake and Ninja from their respective project
+websites.
+
+These instructions start from the `D:` drive. We assume this git repo is cloned
+to `D:\Halide`. We also assume that your shell environment is set up correctly.
+For a 64-bit build, run:
+
+```
+D:\> "C:\Program Files (x86)\Microsoft Visual Studio\2022\Community\VC\Auxiliary\Build\vcvarsall.bat" x64
+```
+
+For a 32-bit build, run:
+
+```
+D:\> "C:\Program Files (x86)\Microsoft Visual Studio\2022\Community\VC\Auxiliary\Build\vcvarsall.bat" x64_x86
+```
+
+#### Managing dependencies with vcpkg
+
+The best way to get compatible dependencies on Windows is to use
+[vcpkg](https://github.com/Microsoft/vcpkg). Install it like so:
+
+```
+D:\> git clone https://github.com/Microsoft/vcpkg.git
+D:\> cd vcpkg
+D:\vcpkg> .\bootstrap-vcpkg.bat -disableMetrics
+...
+CMake projects should use: "-DCMAKE_TOOLCHAIN_FILE=D:/vcpkg/scripts/buildsystems/vcpkg.cmake"
+```
+
+When using the toolchain file, vcpkg will automatically build all the necessary
+dependencies. However, as stated above, be aware that acquiring LLVM this way
+may use over 100 GB of disk space for its build trees and take a very long time
+to build. You can manually delete the build trees afterward, but vcpkg will not
+do this automatically.
+
+See [BuildingHalideWithCMake.md](./doc/BuildingHalideWithCMake.md#vcpkg-presets)
+for directions to use Vcpkg for everything _except_ LLVM.
+
+#### Building Halide
+
+Create a separate build tree and call CMake with vcpkg's toolchain. This will
+build in either 32-bit or 64-bit depending on the environment script (`vcvars`)
+that was run earlier.
+
+```
+D:\Halide> cmake -G Ninja -S . -B build ^
+                 --toolchain D:/vcpkg/scripts/buildsystems/vcpkg.cmake ^
+                 -DCMAKE_BUILD_TYPE=Release
+```
+
+Then run the build with:
+
+```
+D:\Halide> cmake --build build
+```
+
+To run all the tests:
+
+```
+D:\Halide> ctest --test-dir build --output-on-failure
+```
+
+Subsets of the tests can be selected with `-L` and include `correctness`,
+`generator`, `error`, and the other directory names under `tests/`.
+
+#### Building LLVM (optional)
+
+Follow these steps if you want to build LLVM yourself. First, download LLVM's
+sources (these instructions use the 18.1.8 release).
+
+```
+D:\> git clone --depth 1 --branch llvm-org-18.1.8 https://github.com/llvm/llvm-project.git
+```
+
+As above, run `vcvarsall.bat` to pick between x86 and x64. Then configure LLVM
+with the following command (for 32-bit, set `-DLLVM_BUILD_32_BITS=ON` instead):
+
+```
+D:\> cmake -G Ninja -S llvm-project\llvm -B build ^
+           -DCMAKE_BUILD_TYPE=Release ^
+           -DLLVM_ENABLE_PROJECTS=clang;lld;clang-tools-extra ^
+           -DLLVM_ENABLE_RUNTIMES=compiler-rt ^
+           -DLLVM_TARGETS_TO_BUILD=WebAssembly;X86;AArch64;ARM;Hexagon;NVPTX;PowerPC;RISCV ^
+           -DLLVM_ENABLE_ASSERTIONS=ON ^
+           -DLLVM_ENABLE_EH=ON ^
+           -DLLVM_ENABLE_RTTI=ON ^
+           -DLLVM_ENABLE_HTTPLIB=OFF ^
+           -DLLVM_ENABLE_LIBEDIT=OFF ^
+           -DLLVM_ENABLE_LIBXML2=OFF ^
+           -DLLVM_ENABLE_TERMINFO=OFF ^
+           -DLLVM_ENABLE_ZLIB=OFF ^
+           -DLLVM_ENABLE_ZSTD=OFF ^
+           -DLLVM_BUILD_32_BITS=OFF
+```
+
+**MSBuild:** If you want to build LLVM with MSBuild instead of Ninja, use
+`-G "Visual Studio 17 2022" -Thost=x64 -A x64` or
+`-G "Visual Studio 17 2022" -Thost=x64 -A Win32` in place of `-G Ninja`.
+
+Finally, run the build and install to a local directory:
+
+```
+D:\> cmake --build build --config Release
+D:\> cmake --install build --prefix llvm-install
+```
+
+You can substitute `Debug` for `Release` in the above `cmake` commands if you
+want a debug build.
+
+To use this with Halide, but still allow vcpkg to manage other dependencies, you
+must add two flags to Halide's CMake configure command line. First, disable LLVM
+with `-DVCPKG_OVERLAY_PORTS=cmake/vcpkg`. Second, point CMake to our newly built
+Halide with `-DHalide_LLVM_ROOT=D:/llvm-install`.
+
+#### If all else fails...
+
+Do what the buildbots do: https://buildbot.halide-lang.org/master/#/builders
+
+If the row that best matches your system is red, then maybe things aren't just
+broken for you. If it's green, then you can click through to the latest build
+and see the commands that the build bots run. Open a step ("Configure Halide" is
+useful) and look at the "stdio" logs in the viewer. These logs contain the full
+commands that were run, as well as the environment variables they were run with.
+
+## Building Halide with make
+
+> [!WARNING]
+> We do not provide support for the Makefile. Feel free to use it, but if
+> anything goes wrong, switch to the CMake build. Note also that the Makefile
+> cannot build the Python bindings or produce install packages.
+
+*TL;DR*: Have LLVM 17 (or greater) installed and run `make` in the root
+directory of the repository (where this README is).
+
+By default, `make` will use the `llvm-config` tool found in the `PATH`. If you
+want to use a different LLVM, such as a custom-built one following the
+instructions above, set the following environment variable:
+
+```shell
+$ export LLVM_CONFIG="$LLVM_ROOT/bin/llvm-config"
+```
+
+Now you should be able to just run `make` in the root directory of the Halide
+source tree. `make run_tests` will run the JIT test suite, and `make test_apps`
+will make sure all the apps compile and run (but won't check their output).
+
+When building the tests, you can set the AOT compilation target with the 
+`HL_TARGET` environment variable.
+
+### Building Halide out-of-tree with make
+
+If you wish to build Halide in a separate directory, you can do that like so:
+
+```shell
+$ cd ..
+$ mkdir halide_build
+$ cd halide_build
+$ make -f ../Halide/Makefile
+```
+
+# Some useful environment variables
+
+`HL_JIT_TARGET=...` will set Halide's JIT compilation target.
+
+`HL_DEBUG_CODEGEN=1` will print out pseudocode for what Halide is compiling.
+Higher numbers will print more detail.
+
+`HL_NUM_THREADS=...` specifies the number of threads to create for the thread
+pool. When the async scheduling directive is used, more threads than this number
+may be required and thus allocated. A maximum of 256 threads is allowed. (By
+default, the number of cores on the host is used.)
+
+`HL_TRACE_FILE=...` specifies a binary target file to dump tracing data into
+(ignored unless at least one `trace_` feature is enabled in the target). The
+output can be parsed programmatically by starting from the code in
+`utils/HalideTraceViz.cpp`.
+
+# Further references
+
+We have more documentation in `doc/`, the following links might be helpful:
+
+| Document                                      | Description                                                               |
+|-----------------------------------------------|---------------------------------------------------------------------------|
+| [CMake build](doc/BuildingHalideWithCMake.md) | How to configure and build Halide using CMake.                            |
+| [CMake package](doc/HalideCMakePackage.md)    | How to use the Halide CMake package to build your code.                   |
+| [Hexagon](doc/Hexagon.md)                     | How to use the Hexagon backend.                                           |
+| [Python](doc/Python.md)                       | Documentation for the Python bindings.                                    |
+| [RunGen](doc/RunGen.md)                       | How to use the RunGen interface to run and benchmark arbitrary pipelines. |
+| [Vulkan](doc/Vulkan.md)                       | How to use the Halide Vulkan backend (BETA)                               |
+| [WebAssembly](doc/WebAssembly.md)             | How to use the WebAssembly backend and how to use V8 in place of wabt.    |
+| [WebGPU](doc/WebGPU.md)                       | How to run WebGPU pipelines (BETA)                                        |
+
+The following links are of greater interest to developers wishing to contribute
+code to Halide:
+
+| Document                                 | Description                                                                                                   |
+|------------------------------------------|---------------------------------------------------------------------------------------------------------------|
+| [CMake developer](doc/CodeStyleCMake.md) | Guidelines for authoring new CMake code.                                                                      |
+| [FuzzTesting](doc/FuzzTesting.md)        | Information about fuzz testing the Halide compiler (rather than pipelines). Intended for internal developers. |
+| [Testing](doc/Testing.md)                | Information about our test organization and debugging tips. Intended for internal developers.                 |