@@ -17,12 +17,12 @@ in Python without C++.
1717
1818Halide requires C++17 (or later) to use.
1919
20- For more detail about what Halide is, see https://halide-lang.org .
20+ For more detail about what Halide is, see < https://halide-lang.org > .
2121
22- For API documentation see https://halide-lang.org/docs .
22+ For API documentation see < https://halide-lang.org/docs > .
2323
2424For some example code, read through the tutorials online
25- at https://halide-lang.org/tutorials . The corresponding code is in the
25+ at < https://halide-lang.org/tutorials > . The corresponding code is in the
2626` tutorials/ ` directory. Larger examples are in the ` apps/ ` directory.
2727
2828If you've acquired a full source distribution and want to build Halide, see the
@@ -39,14 +39,14 @@ the easiest way to get a binary build of Halide.
3939Full releases may be installed with ` pip ` like so:
4040
4141``` shell
42- $ pip install halide
42+ pip install halide
4343```
4444
4545Every commit to ` main ` is published to Test PyPI as a development version and
4646these may be installed with a few extra flags:
4747
4848``` shell
49- $ pip install halide --pre --extra-index-url https://test.pypi.org/simple
49+ pip install halide --pre --extra-index-url https://test.pypi.org/simple
5050```
5151
5252Currently, we provide wheels for: Windows x86-64, macOS x86-64, macOS arm64, and
@@ -59,7 +59,7 @@ installed it in. On Windows, you will need to add the virtual environment root
5959directory to ` CMAKE_PREFIX_PATH ` . This can be done by running
6060` set CMAKE_PREFIX_PATH=%VIRTUAL_ENV% ` in ` cmd ` .
6161
62- Other build systems can find the Halide root path by running `python -c
62+ Other build systems can find the Halide root path by running `python -c
6363"import halide; print(halide.install_dir())"`.
6464
6565## Homebrew
@@ -68,13 +68,13 @@ Alternatively, if you use macOS, you can install Halide via
6868[ Homebrew] ( https://brew.sh/ ) like so:
6969
7070```
71- $ brew install halide
71+ brew install halide
7272```
7373
7474## Binary tarballs
7575
7676The latest version of Halide can always be found on GitHub
77- at https://github.com/halide/Halide/releases
77+ at < https://github.com/halide/Halide/releases >
7878
7979We provide binary releases for many popular platforms and architectures,
8080including 32/64-bit x86 Windows, 64-bit x86/ARM macOS, and 32/64-bit x86/ARM
@@ -86,24 +86,24 @@ need to adjust compiler options accordingly if you're using an older XCode which
8686does not default to libc++.
8787
8888We use a recent Ubuntu LTS to build the Linux releases; if your distribution is
89- too old, it might not have the requisite glibc.
89+ too old, it might not have the requisite glibc.
9090
9191Nightly builds of Halide and the LLVM versions we use in CI are also available
92- at https://buildbot.halide-lang.org/
92+ at < https://buildbot.halide-lang.org/ >
9393
9494## Vcpkg
9595
9696If you use [ vcpkg] ( https://github.com/microsoft/vcpkg ) to manage dependencies,
9797you can install Halide via:
9898
9999```
100- $ vcpkg install halide:x64-windows # or x64-linux/x64-osx
100+ vcpkg install halide:x64-windows # or x64-linux/x64-osx
101101```
102102
103103One caveat: vcpkg installs only the minimum Halide backends required to compile
104104code for the active platform. If you want to include all the backends, you
105105should install ` halide[target-all]:x64-windows ` instead. Note that since this
106- will build LLVM, it will take a _ lot _ of disk space (up to 100GB).
106+ will build LLVM, it will take a * lot * of disk space (up to 100GB).
107107
108108## Other package managers
109109
@@ -118,7 +118,7 @@ you have experience publishing packages we would be happy to work with you!
118118
119119There are two sets of platform requirements relevant to Halide: those required
120120to run the compiler library in either JIT or AOT mode, and those required to run
121- the _ binary outputs _ of the AOT compiler.
121+ the * binary outputs * of the AOT compiler.
122122
123123These are the ** tested** host toolchain and platform combinations for building
124124and running the Halide compiler library.
@@ -137,7 +137,7 @@ MSVC. We do not actively test these scenarios, however, so your mileage may
137137vary.
138138
139139Beyond these, we are willing to support (by accepting PRs for) platform and
140- toolchain combinations that still receive _ active , first-party, public support _
140+ toolchain combinations that still receive * active , first-party, public support *
141141from their original vendors. For instance, at time of writing, this excludes
142142Windows 7 and includes Ubuntu 18.04 LTS.
143143
@@ -158,14 +158,14 @@ It is simplest to get a binary release of LLVM on macOS by using
158158Linux, the [ LLVM APT repo] ( https://apt.llvm.org ) is best; use the provided
159159installation script. We know of no suitable official binary releases for
160160Windows, however the ones we use in CI can usually be found at
161- https://buildbot.halide-lang.org , along with tarballs for our other tested
161+ < https://buildbot.halide-lang.org > , along with tarballs for our other tested
162162platforms. See [ the section on Windows] ( #windows ) below for further advice.
163163
164164If your OS does not have packages for LLVM, or you want more control over the
165165configuration, you can build it yourself. First check it out from GitHub:
166166
167167``` shell
168- $ git clone --depth 1 --branch llvmorg-21.1.1 https://github.com/llvm/llvm-project.git
168+ git clone --depth 1 --branch llvmorg-21.1.1 https://github.com/llvm/llvm-project.git
169169```
170170
171171(LLVM 21.1.1 is the most recent released LLVM at the time of writing. For
@@ -202,8 +202,8 @@ parallelism. If you choose to omit `-G Ninja`, Makefiles will be generated
202202instead. In this case, enable parallelism with ` cmake --build build -j NNN `
203203where ` NNN ` is the number of parallel jobs, i.e. the number of CPUs you have.
204204
205- Note that you _ must _ add ` clang ` and ` lld ` to ` LLVM_ENABLE_PROJECTS ` and
206- ` WebAssembly ` and ` X86 ` _ must _ be included in ` LLVM_TARGETS_TO_BUILD ` .
205+ Note that you * must * add ` clang ` and ` lld ` to ` LLVM_ENABLE_PROJECTS ` and
206+ ` WebAssembly ` and ` X86 ` * must * be included in ` LLVM_TARGETS_TO_BUILD ` .
207207` LLVM_ENABLE_RUNTIMES=compiler-rt ` is only required to build the fuzz tests, and
208208` clang-tools-extra ` is only necessary if you plan to contribute code to Halide
209209(so that you can run ` clang-tidy ` on your pull requests). You can disable
@@ -223,7 +223,7 @@ Follow the above instructions to build LLVM or acquire a suitable binary
223223release. Then change directory to the Halide repository and run:
224224
225225``` shell
226- $ cmake -G Ninja -S . -B build -DCMAKE_BUILD_TYPE=Release -DHalide_LLVM_ROOT=$LLVM_ROOT
226+ $ cmake -G Ninja -S . -B build -DCMAKE_BUILD_TYPE=Release -DHalide_LLVM_ROOT=$LLVM_ROOT
227227$ cmake --build build
228228```
229229
@@ -274,7 +274,7 @@ to build. You can manually delete the build trees afterward, but vcpkg will not
274274do this automatically.
275275
276276See [ BuildingHalideWithCMake.md] ( ./doc/BuildingHalideWithCMake.md#vcpkg-presets )
277- for directions to use Vcpkg for everything _ except _ LLVM.
277+ for directions to use Vcpkg for everything * except * LLVM.
278278
279279#### Building Halide
280280
@@ -352,9 +352,9 @@ must add two flags to Halide's CMake configure command line. First, disable LLVM
352352with ` -DVCPKG_OVERLAY_PORTS=cmake/vcpkg ` . Second, point CMake to our newly built
353353Halide with ` -DHalide_LLVM_ROOT=D:/llvm-install ` .
354354
355- #### If all else fails...
355+ #### If all else fails
356356
357- Do what the buildbots do: https://buildbot.halide-lang.org/master/#/builders
357+ Do what the buildbots do: < https://buildbot.halide-lang.org/master/#/builders >
358358
359359If the row that best matches your system is red, then maybe things aren't just
360360broken for you. If it's green, then you can click through to the latest build
@@ -377,25 +377,25 @@ want to use a different LLVM, such as a custom-built one following the
377377instructions above, set the following environment variable:
378378
379379``` shell
380- $ export LLVM_CONFIG=" $LLVM_ROOT /bin/llvm-config"
380+ export LLVM_CONFIG=" $LLVM_ROOT /bin/llvm-config"
381381```
382382
383383Now you should be able to just run ` make ` in the root directory of the Halide
384384source tree. ` make run_tests ` will run the JIT test suite, and ` make test_apps `
385385will make sure all the apps compile and run (but won't check their output).
386386
387- When building the tests, you can set the AOT compilation target with the
387+ When building the tests, you can set the AOT compilation target with the
388388` HL_TARGET ` environment variable.
389389
390390### Building Halide out-of-tree with make
391391
392392If you wish to build Halide in a separate directory, you can do that like so:
393393
394394``` shell
395- $ cd ..
396- $ mkdir halide_build
397- $ cd halide_build
398- $ make -f ../Halide/Makefile
395+ cd ..
396+ mkdir halide_build
397+ cd halide_build
398+ make -f ../Halide/Makefile
399399```
400400
401401# Some useful environment variables
0 commit comments