Skip to content

Commit eda80f4

Browse files
committed
docs: improve rendering of Windows on Arm instructions
1 parent 1833e68 commit eda80f4

File tree

1 file changed

+39
-20
lines changed

1 file changed

+39
-20
lines changed

docs/install.md

Lines changed: 39 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -443,28 +443,43 @@ A fully functional native OpenBLAS for WoA that can be built as both a static an
443443
(Note that you can use the free "Visual Studio 2022 Community Edition" for this task. In principle it would be possible to build with VisualStudio alone, but using
444444
the LLVM toolchain enables native compilation of the Fortran sources of LAPACK and of all the optimized assembly files, which VisualStudio cannot handle on its own)
445445
446-
1. Clone OpenBLAS to your local machine and checkout to latest release of OpenBLAS (unless you want to build the latest development snapshot - here we are using the 0.3.28 release as the example, of course this exact version may be outdated by the time you read this)
446+
1. Clone OpenBLAS to your local machine and checkout to latest release of
447+
OpenBLAS (unless you want to build the latest development snapshot - here we
448+
are using the 0.3.28 release as the example, of course this exact version
449+
may be outdated by the time you read this)
447450
448-
```cmd
449-
git clone https://github.com/OpenMathLib/OpenBLAS.git
450-
cd OpenBLAS
451-
git checkout v0.3.28
452-
```
451+
```cmd
452+
git clone https://github.com/OpenMathLib/OpenBLAS.git
453+
cd OpenBLAS
454+
git checkout v0.3.28
455+
```
453456
454457
2. Install Latest LLVM toolchain for WoA:
455458
456-
Download the Latest LLVM toolchain for WoA from [the Release page](https://github.com/llvm/llvm-project/releases/tag/llvmorg-19.1.5). At the time of writing, this is version 19.1.5 - be sure to select the latest release for which you can find a precompiled package whose name ends in "-woa64.exe" (precompiled packages
457-
usually lag a week or two behind their corresponding source release).
458-
Make sure to enable the option “Add LLVM to the system PATH for all the users”
459-
Note: Make sure that the path of LLVM toolchain is at the top of Environment Variables section to avoid conflicts between the set of compilers available in the system path
459+
Download the Latest LLVM toolchain for WoA from [the Release
460+
page](https://github.com/llvm/llvm-project/releases/tag/llvmorg-19.1.5). At
461+
the time of writing, this is version 19.1.5 - be sure to select the
462+
latest release for which you can find a precompiled package whose name ends
463+
in "-woa64.exe" (precompiled packages usually lag a week or two behind their
464+
corresponding source release). Make sure to enable the option
465+
*“Add LLVM to the system PATH for all the users”*.
466+
467+
Note: Make sure that the path of LLVM toolchain is at the top of Environment
468+
Variables section to avoid conflicts between the set of compilers available
469+
in the system path
460470
461471
3. Launch the Native Command Prompt for Windows ARM64:
462472
463-
From the start menu search for “ARM64 Native Tools Command Prompt for Visual Studio 2022
464-
Alternatively open command prompt, run the following command to activate the environment:
465-
"C:\Program Files\Microsoft Visual Studio\2022\Community\VC\Auxiliary\Build\vcvarsarm64.bat"
473+
From the start menu search for *"ARM64 Native Tools Command Prompt for Visual
474+
Studio 2022"*. Alternatively open command prompt, run the following command to
475+
activate the environment:
476+
477+
```cmd
478+
C:\Program Files\Microsoft Visual Studio\2022\Community\VC\Auxiliary\Build\vcvarsarm64.bat
479+
```
466480
467-
Navigate to the OpenBLAS source code directory and start building OpenBLAS by invoking Ninja:
481+
4. Navigate to the OpenBLAS source code directory and start building OpenBLAS
482+
by invoking Ninja:
468483
469484
```cmd
470485
cd OpenBLAS
@@ -476,14 +491,18 @@ Navigate to the OpenBLAS source code directory and start building OpenBLAS by in
476491
ninja -j16
477492
```
478493
479-
Note: You might want to include additional options in the cmake command here. For example, the default configuration only generates a static.lib version of the library. If you prefer a DLL, you can add -DBUILD_SHARED_LIBS=ON.
480-
481-
Note that it is also possible to use the same setup to build OpenBLAS with Make, if you prepare Makefiles over the CMake build for some reason:
494+
Note: You might want to include additional options in the cmake command
495+
here. For example, the default configuration only generates a
496+
`static.lib` version of the library. If you prefer a DLL, you can add
497+
`-DBUILD_SHARED_LIBS=ON`.
482498
483-
```cmd
484-
$ make CC=clang-cl FC=flang-new AR="llvm-ar" TARGET=ARMV8 ARCH=arm64 RANLIB="llvm-ranlib" MAKE=make
485-
```
499+
Note that it is also possible to use the same setup to build OpenBLAS
500+
with Make, if you prefer Makefiles over the CMake build for some
501+
reason:
486502
503+
```cmd
504+
$ make CC=clang-cl FC=flang-new AR="llvm-ar" TARGET=ARMV8 ARCH=arm64 RANLIB="llvm-ranlib" MAKE=make
505+
```
487506
488507
489508
#### Generating an import library

0 commit comments

Comments
 (0)