46 lines
1.6 KiB
Markdown
46 lines
1.6 KiB
Markdown
<p align="center">
|
|
<h1 align="center">TermKitBackend</h1>
|
|
</p>
|
|
|
|
<p align="center">
|
|
<a href="https://term-kit-backend.aparoksha.dev/">
|
|
Documentation
|
|
</a>
|
|
·
|
|
<a href="https://git.aparoksha.dev/david-swift/term-kit-backend">
|
|
Code
|
|
</a>
|
|
</p>
|
|
|
|
_TermKitBackend_ is a declarative framework allowing the creation of user interfaces 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://meta.aparoksha.dev/), browse the code [here](https://git.aparoksha.dev/aparoksha/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://meta.aparoksha.dev/). Find the available widgets [here](https://term-kit-backend.aparoksha.dev/).
|
|
|
|
## Usage
|
|
|
|
Follow the tutorial in the [docs](https://term-kit-backend.aparoksha.dev/).
|
|
|
|
## 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://git.aparoksha.dev/aparoksha/meta) licensed under the [MIT License](https://git.aparoksha.dev/aparoksha/meta/src/branch/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)
|