https://github.com/int-index/slay

Source Layouting Engine
https://github.com/int-index/slay

Last synced: 10 days ago
JSON representation

Source Layouting Engine

• Host: GitHub
• URL: https://github.com/int-index/slay
• Owner: int-index
• Created: 2017-07-27T09:54:38.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2021-03-07T11:28:37.000Z (over 3 years ago)
• Last Synced: 2024-10-11T23:53:05.993Z (27 days ago)
• Language: Haskell
• Homepage:
• Size: 116 KB
• Stars: 11
• Watchers: 6
• Forks: 1
• Open Issues: 5
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Slay: a layouting engine

[![Build Status](https://img.shields.io/travis/int-index/slay.svg)](https://travis-ci.org/int-index/slay)

## Building instructions

```

./nix-cabal v2-build all

```

To achieve reproducible builds the versions of Haskell dependencies are

pinned in the `cabal.project.freeze` file.

Specify additional build options in `cabal.project.local`:

```

profiling: True

documentation: True

```

## Project structure

The main package is `slay-core`, it contains the layouting engine.

The only job of the layouting engine is to position primitives on a

2-dimensional plane. It doesn't matter whether the primitives are for a

pixel-based canvas or for a character-based terminal. Therefore, there are many

possible backends:

* `slay-cairo` implements a few primitives on top of the `cairo` drawing engine

* `slay-vty` implements a thin layer over `vty` for terminal pseudographics

* `slay-web` (not implemented yet) will support browsers

The `slay-combinators` package defines common positioning strategies, such as

horizontal and vertical juxtaposition, and various helper functions for

positioning. For now it's quite simplistic, but sophisticated positioning

algorithms can be added there in the future.

There are also packages that serve as a testing ground for development and provide

examples of using the library. For now there's only one such package, `slay-gtk`.