mirror of
https://github.com/garraflavatra/rolens.git
synced 2025-01-18 21:17:59 +00:00
51 lines
2.8 KiB
Markdown
51 lines
2.8 KiB
Markdown
# Installation procedure
|
|
|
|
## System requirements
|
|
|
|
Rolens can run on the following operating systems:
|
|
|
|
* Windows 10/11 amd64/arm64
|
|
* Linux amd64/arm64
|
|
* macOS 10.13+ amd64 (Intel)
|
|
* macOS 11.0+ arm64 (Apple Silicon)
|
|
|
|
## Pre-compiled binaries
|
|
|
|
You can obtain a pre-compiled Rolens.app for macOS or installer for Windows from the [release page](https://github.com/garraflavatra/rolens/releases/latest).
|
|
|
|
If you use a Linux-based OS, please continue reading.
|
|
|
|
## Compile from source in 2 easy steps
|
|
|
|
Rolens is free and open-source software, which means that you can compile it from source on your own machine by cloning [the repository](https://github.com/garraflavatra/rolens).
|
|
|
|
If you have Node.js installed, just download the source from GitHub, and run `./build.js`. The install script will check that dependencies are present and build Rolens for you. If you want to build it yourself, please continue reading.
|
|
|
|
## Advanced build
|
|
|
|
### Prerequisites
|
|
|
|
Rolens is written in Go, so you should download the Go compiler from [the download page](https://go.dev/dl/). The minimum version required is 1.18. You can confirm whether it's installed correctly by running `go version` and checking that it outputs something similar to `go1.18.2`.
|
|
|
|
Furthermore, you need to have [Wails ^3.1](https://wails.io/docs/gettingstarted/installation) 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](https://nodejs.org/en/download) ^16.0 and the [npm](https://npmjs.com) 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](https://github.com/garraflavatra/rolens/releases/latest). Make sure you download the source archive, and not a pre-compiled binary.
|
|
* Or clone [the Git repository](https://github.com/garraflavatra/rolens): `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](https://nsis.sourceforge.io/Main_Page) 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`](https://www.man7.org/linux/man-pages/man1/ulimit.1p.html) (or whichever value) on *nix systems.
|