Skip to content

Latest commit

 

History

History
109 lines (81 loc) · 3.12 KB

rnote-macos-build.md

File metadata and controls

109 lines (81 loc) · 3.12 KB
Raw

Build Instructions for macOS

Dependencies

  • git
  • cargo (the Rust toolchain in general)
  • ninja (backend for meson)
  • meson
  • Glib (glib-2.0)
  • Gio (gio-2.0)
  • GTK4
  • Libadwaita (libadwaita-1)
  • Poppler (poppler-glib)

Installing Rust

Rust is a necessary dependency and you are recommended to install it via rustup. You will also need a C compiler.

xcode-select --install # install command-line utilities (including the clang compiler)
curl --proto '=https' --tlsv1.2 https://sh.rustup.rs -sSf | sh # install rustup
rustup toolchain install stable

To learn more about rustup, you can check out the Rust website.

Installing Other Dependencies

Homebrew is the most widely used package manager for macOS. If you don't have it installed already, you can install it with the following command:

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

Then, you can install the rest of the required dependencies using the brew install command.

brew install git ninja meson glib appstream gtk4 poppler desktop-file-utils libadwaita

Cloning the Repository

Once you have all the required dependencies, you can clone the repository by navigating to a directory in which to place the project and then running the following commands:

git clone https://github.com/flxzt/rnote.git
cd rnote
git submodule update --init --recursive

Then, navigate into the rnote directory and follow the build and installation steps listed below.

Building and Installing the Project

First, we have to setup the build directory. These steps will differ slightly from those listed in the BUILDING.md file.

First, we must setup the build directory. prefix will be set to usr/local here because /usr is protected by SIP by default. You can choose to disable SIP instead if you'd like, but this isn't a recommended solution.

meson setup --prefix=usr/local _mesonbuild

Next, we have to build rnote.

meson compile -C _mesonbuild

Now, we can install the binary and place resource files in their desired locations. sudo is required because prefix is set to /usr/local. You can set it to, say, somewhere in your home directory if you'd to avoid having to use sudo.

sudo meson install -C _mesonbuild

We must also append the path to the directory containing the gschema file to the GSETTINGS_SCHEMA_DIR environment variable. You can simply run the following command before running rnote or add it to your .zshrc. If you set prefix to a different path, you will have to alter the following command accordingly.

GSETTINGS_SCHEMA_DIR=$GSETTINGS_SCHEMA_DIR:/usr/local/share/glib-2.0/schemas

Now, rnote should be installed in /usr/local/bin (depending on what you set the value of prefix to be).

Installing as an Application

TODO