Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 3 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,30 +23,14 @@ winget install --id DEVCOM.Lua
[Clang](https://clang.llvm.org/))
- [CMake](https://cmake.org/)
- [Ninja](https://ninja-build.org/)
- [ImageMagick](https://imagemagick.org/)
- [GhostScript](https://www.ghostscript.com/)
- [WiX v3](https://wixtoolset.org/docs/wix3/)

You can install the first five components with the following
You can install these components with the following
[winget](https://learn.microsoft.com/windows/package-manager/winget/) commands:

```powershell
winget install --id LLVM.LLVM
winget install --id Kitware.CMake
winget install --id Ninja-build.Ninja
winget install --id ImageMagick.ImageMagick
winget install --id ArtifexSoftware.GhostScript
```

WiX v3 is available at <https://github.com/wixtoolset/wix3/releases/>. It
requires .NET Framework 3.5 that can be installed with the following command:

```powershell
Start-Process `
-FilePath pwsh `
-ArgumentList "-Command `"& {Enable-WindowsOptionalFeature -Online -FeatureName NetFx3}`"" `
-Wait `
-Verb RunAs
```

Update your path environment with `setx` (supposing you installed the tools in
Expand All @@ -63,17 +47,14 @@ Check if `PATH` was set correctly:
Get-Command clang
Get-Command cmake
Get-Command ninja
Get-Command magick
Get-Command gswin64
```

You may need to restart your Windows session if you can't find `ninja` even
after restarting your terminal.

## Build

Use the following commands to generate the installation package in both ZIP and
MSI formats:
Use the following commands to generate a ZIP package with Lua and LuaRocks:

```powershell
cmake -B build -G Ninja -D CMAKE_BUILD_TYPE=RelWithDebInfo
Expand All @@ -85,4 +66,4 @@ code and LuaRocks binaries.

For convenience, you can use the `Build-Lua.ps1` script to run these commands.

If successful, the ZIP and MSI files will be available in the `build` directory.
If successful, the ZIP file will be available in the `build` directory.