Installation

This section describes all steps for installing Quartz.

Requirements

Since Quartz is written in the Crystal programming language, its compiler is needed to build Quartz from sources.

Please refer to for instructions for your operating system.

Setup

Using Crystal dependency manager

The simplest way to use Quartz as a dependency for defining models is using Crystal dependency manager.

Crystal applications and libraries are expected to have a shard.yml file at their root. Create a shard.yml file in your project's folder (or add to it) with the following contents:

dependencies:
  quartz:
    github: RomainFranceschini/quartz

Then, resolve dependencies with shards to install Quartz and its requirements as a dependency of your project:

$ shards install

This will download the latest version from Quartz repository. Note you may specify a version by adding the version: 1.0.0 to shard.yml under the quartz dependency.

Manually

Note you can link a cloned repository of quartz to your project's folder through a symlink.

mkdir lib
ln -s /path/to/quartz/src lib/quartz

Note shards install should be run within the Quartz repository.

Usage

Add require "quartz" to your main project file.

You are now ready to use Quartz API.

---

Next: Time representation