Advanced build process

If you just want to install Rolens, please refer to the installation document. You can read this guide to get a detailed overview of the build procedure.

Prerequisites

Rolens is written in Go, so you should download the Go compiler from the download page. The minimum version required is 1.20. You can confirm whether it’s installed correctly by running go version and checking that it outputs something similar to go1.20.4 or higher.

Furthermore, you need to have Wails ^3.1 installed: go install github.com/wailsapp/wails/v2/cmd/wails@latest. Wails may have platform-specific dependencies; you can consult wails doctor to find out what dependencies Wails needs and how to install them.

In order to compile the frontend, Node.js ^16.0 and the npm package manager ^8.0 (included in Node.js) are required. To confirm the installed versions of those tools, execute node -v and npm -v.

Download source

To obtain a copy of the source code, do either of the following:

• Download a tarball or zip archive from the release page. Make sure you download the source archive, and not a pre-compiled binary.
• Or clone the Git repository: git clone https://github.com/garraflavatra/rolens.git.

Compile

cd into the root directory of the source code and run either:

• wails build to generate an executable for your platform.
• wails build -nsis to generate an NSIS installer for Windows. This requires that you have NSIS installed on your machine.

The generated binary will live in build/bin. You may want to run the installer (Windows) or move the app to the Applications folder (Mac).

If Wails complains that there are too many open files, you can try to increase the maximum number of open files using ulimit -f 1024 (or whichever value) on *nix systems.