mirror of
https://github.com/garraflavatra/rolens.git
synced 2025-01-18 21:17:59 +00:00
Update some links in documentation
This commit is contained in:
parent
88a5b961b1
commit
3dbf8fc98b
26
INSTALL.md
26
INSTALL.md
@ -1,26 +0,0 @@
|
|||||||
# 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
|
|
||||||
|
|
||||||
Please see the [advanced build documentation](https://garraflavatra.github.io/rolens/development/advanced-build/) for a more profound insight in the build procedure.
|
|
@ -38,7 +38,7 @@ You can obtain a pre-compiled Rolens binary for macOS or installer for Windows f
|
|||||||
|
|
||||||
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 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 refer to [the documentation](https://garraflavatra.github.io/rolens/installation/) for detailed compilation instructions.
|
If you want to build it yourself, please refer to the [advanced build process documentation](https://garraflavatra.github.io/rolens/development/advanced-build/) for detailed compilation instructions.
|
||||||
|
|
||||||
## User guide
|
## User guide
|
||||||
|
|
||||||
@ -52,8 +52,6 @@ Rolens is designed to be as intuitive as possible. But if something is unclear n
|
|||||||
|
|
||||||
Feel free to contact me if you have questions! [Send an e-mail.](mailto:romein@vburen.nl)
|
Feel free to contact me if you have questions! [Send an e-mail.](mailto:romein@vburen.nl)
|
||||||
|
|
||||||
## Con
|
|
||||||
|
|
||||||
## Author and license
|
## Author and license
|
||||||
|
|
||||||
© [Romein van Buren](mailto:romein@vburen.nl) 2023. The source code and compiled binaries are released under the GNU GPLv3 license — see [`LICENSE`](./LICENSE) for the full license text.
|
© [Romein van Buren](mailto:romein@vburen.nl) 2023. The source code and compiled binaries are released under the GNU GPLv3 license — see [`LICENSE`](./LICENSE) for the full license text.
|
||||||
|
@ -4,7 +4,7 @@ parent: Development
|
|||||||
order: 10
|
order: 10
|
||||||
---
|
---
|
||||||
|
|
||||||
If you just want to install Rolens, please refer to the [installation document](https://garraflavatra.github.io/rolens/installation/). You can read this guide to get a detailed overview of the build procedure.
|
If you just want to install Rolens, please refer to the [installation document](/installation/). You can read this guide to get a detailed overview of the build procedure.
|
||||||
|
|
||||||
## Prerequisites
|
## Prerequisites
|
||||||
|
|
||||||
|
@ -3,4 +3,27 @@ title: Installation
|
|||||||
order: 20
|
order: 20
|
||||||
---
|
---
|
||||||
|
|
||||||
{% filecontent "../INSTALL.md", 2 %}
|
## 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
|
||||||
|
|
||||||
|
Please see the [advanced build documentation](/development/advanced-build/) for a more profound insight in the build procedure.
|
||||||
|
Loading…
Reference in New Issue
Block a user