ctlseqs/README.md

25 lines
1001 B
Markdown
Raw Normal View History

2020-12-14 13:12:09 +00:00
<!--
2021-01-10 17:53:38 +00:00
Copyright (C) 2020,2021 CismonX <admin@cismon.net>
2020-12-14 13:12:09 +00:00
Copying and distribution of this file, with or without modification, are
permitted in any medium without royalty, provided the copyright notice and
this notice are preserved. This file is offered as-is, without any warranty.
-->
# README
2021-01-23 19:41:56 +00:00
[![Build Status](https://drone.cismon.net/api/badges/CismonX/ctlseqs/status.svg)](https://drone.cismon.net/CismonX/ctlseqs)
2021-01-25 06:17:06 +00:00
[![License](https://img.shields.io/badge/license-GPL--3.0--or--later-blue.svg)](COPYING)
2020-12-14 13:12:09 +00:00
2020-12-20 20:21:28 +00:00
## About
2020-12-14 13:12:09 +00:00
2021-01-25 06:17:06 +00:00
The ctlseqs library provides C API for handling ECMA-35/ECMA-48 compatible escape sequences, which is commonly used for communication between terminal emulators and text-based programs.
2020-12-14 13:12:09 +00:00
2020-12-20 20:21:28 +00:00
## Getting Started
2020-12-14 13:12:09 +00:00
2021-01-25 06:17:06 +00:00
For installation instructions, see [INSTALL.md](INSTALL.md).
2020-12-14 13:12:09 +00:00
2021-01-25 06:17:06 +00:00
[Documentation](doc/ctlseqs.texi) of the library can be read [online](.), or read with `info ctlseqs` after installation.
2020-12-14 13:12:09 +00:00
Some [examples](examples) are provided to demonstrate the basic usage of this library.