Skip to content
This repository has been archived by the owner on Sep 17, 2024. It is now read-only.

Latest commit

 

History

History
107 lines (72 loc) · 2.08 KB

INSTALL.md

File metadata and controls

107 lines (72 loc) · 2.08 KB
Raw

Install

Third Party Repositories

Cargo

cargo install ajour

Homebrew

brew install --cask ajour

Chocolatey

Standard

choco install ajour

OpenGL

choco install ajour-opengl

Manual Installation

  1. Prerequisites
    1. Source Code
    2. Rust Compiler
    3. Dependencies
      1. Debian/Ubuntu
      2. Other
  2. Building
    1. Linux/Windows
    2. macOS
    3. Compatibility build

Prerequisites

Clone the source code

Before compiling Ajour, you need the source code

git clone https://github.com/ajour/ajour.git
cd ajour

Install the Rust compiler with rustup

Ensure you have installed the Rust compiler rustup.rs.

Dependencies

Depending on what system you are building the source code on, additional dependencies might be required.

Debian/Ubuntu
sudo apt install build-essential cmake libxft-dev libssl-dev libx11-dev libxkbcommon-dev
Other

If your system has extra dependencies, and they are not listed here please create a pull-request or open a issue.

Building

Linux / Windows

cargo build --release

The application executable will be built to

target/release/ajour

macOS

make app
cp -r target/release/osx/Ajour.app /Applications/

Compatibility build

Ajour is built using wgpu which has requirements which might not be achievable by all. It is therefore possible to build a compatability build using opengl as renderer instead. Performance should be close to 1:1.

To build a compatability build add the flag --no-default-features --features opengl

cargo build --release --no-default-features --features opengl