rolens/docs/installation.md

---
title: Installation
summary: Install Rolens on your machine.
order: 20
---

## 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 `node ./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

Please see the [advanced build documentation](/development/advanced-build/) for a more profound insight in the build procedure.
Documentation website 2023-06-01 22:06:51 +02:00			`---`
			`title: Installation`
Added some PR talk 2023-06-29 14:37:39 +02:00			`summary: Install Rolens on your machine.`
Documentation website 2023-06-01 22:06:51 +02:00			`order: 20`
			`---`
Added some documentation 2023-05-31 16:07:57 +02:00
Update some links in documentation 2023-06-29 10:16:29 +02:00			`## 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).`

Attempt to fix build.js 2023-06-30 20:09:36 +02:00			If you have Node.js installed, just download the source from GitHub, and run `node ./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.
Update some links in documentation 2023-06-29 10:16:29 +02:00
			`## Advanced build`

			`Please see the [advanced build documentation](/development/advanced-build/) for a more profound insight in the build procedure.`