romein/rolens
1
0
Fork 0
mirror of https://github.com/garraflavatra/rolens.git synced 2024-11-21 22:18:59 +01:00
Code Issues Releases Activity
9eac9ae935
rolens/build/README.md

2.4 KiB
Raw Blame History

Build Directory

The build directory is used to house all the build files and assets for the application.

Mac

The darwin directory holds files specific to Mac builds. These may be customised and used as part of the build. To return these files to the default state, simply delete them and build with wails build.

The directory contains the following files:

  • Info.plist - the main plist file used for Mac builds. It is used when building using wails build.
  • Info.dev.plist - same as the main plist file but used when building using wails dev.

Windows

The windows directory contains the manifest and rc files used when building with wails build. These may be customised for the application. To return these files to the default state, simply delete them and build with wails build.

  • icon.ico - The icon used for the application. This is used when building using wails build. If it is missing, a new icon.ico file will be created using the appicon.png file in the build directory.
  • installer/* - The files used to create the Windows installer. These are used when building using wails build.
  • info.json - Application details used for Windows builds. The data here will be used by the Windows installer, as well as the application itself (right click the exe -> properties -> details)
  • wails.exe.manifest - The main application manifest file.

NSIS graphics

When updating the bitmaps for the NSIS installer, make sure you export a 24-bits image without colour space information. Follow this guide:

These steps worked for me using GIMP 2.8.10:

  • Create an image using RGB mode (Image > Mode > RGB) using the appropriate size for whatever you are creating (164x314 for MUI_WELCOMEFINISHPAGE_BITMAP, 150x57 for MUI_HEADERIMAGE_BITMAP)
  • File > Export as ...
  • Name your file with a .bmp extension
  • Click "Export"
  • In the window titled "Export Image as BMP" expand "Compatibility Options" and check the box that says "Do not write color space information"
  • Also, in the window titled "Export Image as BMP" expand "Advanced Options" and check the radio button under "24 bits" next to "R8 G8 B8"
  • Click "Export"

CI scripts

Each platform folder inside this directory contains a ci_generate.* file, which is used by GitHub Actions to build the application. When you want to compile Rolens on your machine, please refer to the installation instructions.