Skip to content

Commit b115905

Browse files
committed
update readme
1 parent 9e33c23 commit b115905

File tree

1 file changed

+37
-5
lines changed

1 file changed

+37
-5
lines changed

README.md

Lines changed: 37 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,12 @@ of Lua.
1010

1111
## Prerequisites
1212

13-
- C compiler (Microsoft Visual C++ or Clang)
14-
- CMake
15-
- Ninja
16-
- WiX Toolset
13+
- C compiler ([Microsoft Visual
14+
C++](https://learn.microsoft.com/cpp/overview/visual-cpp-in-visual-studio) or
15+
[Clang](https://clang.llvm.org/))
16+
- [CMake](https://cmake.org/)
17+
- [Ninja](https://ninja-build.org/)
18+
- [WiX v3](https://wixtoolset.org/docs/wix3/) (if packaging on Windows)
1719

1820
You can install the first three components with the following
1921
[winget](https://learn.microsoft.com/windows/package-manager/winget/) commands:
@@ -23,7 +25,36 @@ winget install --id LLVM.LLVM
2325
winget install --id Kitware.CMake
2426
winget install --id Ninja-build.Ninja
2527
```
26-
WiX Toolset is available at <https://github.com/wixtoolset/wix3/releases/>.
28+
29+
WiX v3 is available at <https://github.com/wixtoolset/wix3/releases/>. It
30+
requires .NET Framework 3.5 that can be installed with the following command:
31+
32+
```powershell
33+
Start-Process `
34+
-FilePath pwsh `
35+
-ArgumentList "-Command `"& {Enable-WindowsOptionalFeature -Online -FeatureName NetFx3}`"" `
36+
-Wait `
37+
-Verb RunAs
38+
```
39+
40+
Update your path environment with `setx` (supposing you installed the tools in
41+
their default directories):
42+
43+
```powershell
44+
setx PATH ($(Get-ItemProperty -Path HKCU:\Environment -Name Path).Path + "$env:ProgramFiles\LLVM\bin;${env:ProgramFiles(x86)}\WiX Toolset v3.11\bin")
45+
```
46+
47+
Check if `PATH` was set correctly:
48+
49+
```
50+
Get-Command clang
51+
Get-Command cmake
52+
Get-Command ninja
53+
Get-Command candle
54+
```
55+
56+
You may need to restart your Windows session if you can't find `ninja` even
57+
after restarting your terminal.
2758

2859
## Build
2960

@@ -34,6 +65,7 @@ MSI formats:
3465
cmake -B build -G Ninja -D CMAKE_BUILD_TYPE=RelWithDebInfo
3566
cmake --build build --target package
3667
```
68+
3769
You need Internet access to execute the build process to download the Lua source
3870
code and LuaRocks binaries.
3971

0 commit comments

Comments
 (0)