term-kit-backend/README.md

<p align="center">
  <h1 align="center">TermKitBackend</h1>
</p>

<p align="center">
  <a href="https://david-swift.github.io/TermKitBackend/">
  Documentation
  </a>
  ·
  <a href="https://github.com/david-swift/TermKitBackend">
  GitHub
  </a>
</p>

_TermKitBackend_ is a declarative framework allowing the creation of user interface for the terminal. It works on Linux and macOS thanks to the [TermKit project](https://github.com/migueldeicaza/TermKit).

## Table of Contents

- [Overview](#overview)
- [Usage](#usage)
- [Thanks](#thanks)

## Overview

The declarative approach is based on the [Meta package](https://aparokshaui.github.io/Meta/) which can be found on [GitHub](https://github.com/AparokshaUI/Meta).
It is powered by [a fork of TermKit for Swift](https://github.com/david-swift/TermKit).

Detailed information about the declarative approach can be found in the [Meta docs](https://aparokshaui.github.io/meta/). Find the available widgets [here](https://david-swift.github.io/TermKitBackend).

## Usage

Follow the tutorial in the [docs](https://david-swift.github.io/TermKitBackend).

## Thanks

### Dependencies

- [TermKit](https://github.com/david-swift/TermKit) licensed under the [MIT License](https://github.com/david-swift/TermKit/blob/main/LICENSE)
- [Meta](https://github.com/AparokshaUI/Meta) licensed under the [MIT License](https://github.com/AparokshaUI/Meta/blob/main/LICENSE.md)

### Other Thanks

- [DocC](https://github.com/apple/swift-docc) used for the documentation
- [SwiftLint](https://github.com/realm/SwiftLint) for checking whether code style conventions are violated
- The programming language [Swift](https://github.com/swiftlang/swift)