Update README and config scripts.
continuous-integration/drone/push Build is passing
Details
continuous-integration/drone/push Build is passing
Details
This commit is contained in:
parent
1c661db632
commit
012bb4ef6f
|
@ -14,7 +14,7 @@ steps:
|
||||||
- name: build
|
- name: build
|
||||||
image: pureos/amber-slim
|
image: pureos/amber-slim
|
||||||
commands:
|
commands:
|
||||||
- apt install --assume-yes build-essential autoconf automake libtool autoconf-archive dejagnu texinfo
|
- apt -y install build-essential autoconf automake libtool autoconf-archive dejagnu texinfo
|
||||||
- autoreconf --install
|
- autoreconf --install
|
||||||
- ./configure CFLAGS='-O0 -g -std=c99 -Wall -Wextra -Wpedantic --coverage'
|
- ./configure CFLAGS='-O0 -g -std=c99 -Wall -Wextra -Wpedantic --coverage'
|
||||||
- make
|
- make
|
||||||
|
|
30
INSTALL.md
30
INSTALL.md
|
@ -8,39 +8,27 @@ this notice are preserved. This file is offered as-is, without any warranty.
|
||||||
|
|
||||||
# INSTALL
|
# INSTALL
|
||||||
|
|
||||||
## Copy Library Code to Your Project
|
## Copy Code to Your Project
|
||||||
|
|
||||||
This is the recommended way to use this library.
|
The code of ctlseqs is simple, and can be used out-of-the-box. Just copy [ctlseqs.h](src/ctlseqs.h) and [ctlseqs.c](src/ctlseqs.c) to your project and build it alongside with other code.
|
||||||
|
|
||||||
Copy [ctlseqs.h](src/ctlseqs.h) and [ctlseqs.c](src/ctlseqs.c) to your project and build it alongside with other code. Requires an ISO C99 and POSIX.1-2001 compliant C implementation.
|
Requires an ISO C99 and POSIX.1-2001 compliant C implementation.
|
||||||
|
|
||||||
## Build and Install From Source
|
## Build and Install From Source
|
||||||
|
|
||||||
Helper scripts are provided to build ctlseqs as a shared/static library. Requires GNU Autoconf, Automake, Libtool and Autoconf Archive.
|
Alternatively, ctlseqs can be built into a shared/static library with GNU Autotools (Autoconf, Automake, Libtool and Autoconf Archive).
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
autoreconf --install
|
autoreconf --install
|
||||||
./configure --prefix=$HOME CFLAGS='-O0 -g'
|
./configure
|
||||||
make
|
make
|
||||||
```
|
```
|
||||||
|
|
||||||
Optionally, you can run tests (requires DejaGnu), install the binary and man pages.
|
Optionally, you can run tests (requires DejaGnu) and install the library.
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
make check && make install
|
make check
|
||||||
|
make install
|
||||||
```
|
```
|
||||||
|
|
||||||
Finally, link it to your project with the `-lctlseqs` flag (or something similar).
|
Unix man pages are not automatically installed with `make install`, and should be installed manually with `make install-man`.
|
||||||
|
|
||||||
## Install From a Package Manager
|
|
||||||
|
|
||||||
We maintain unofficial repositories for a few package managers, so that the ctlseqs library can be installed from them.
|
|
||||||
|
|
||||||
However, there is no guarantee that any of those repositories will be actively maintained in the future.
|
|
||||||
|
|
||||||
### Homebrew
|
|
||||||
|
|
||||||
```shell
|
|
||||||
brew tap CismonX/repos
|
|
||||||
brew install ctlseqs
|
|
||||||
```
|
|
||||||
|
|
12
README.md
12
README.md
|
@ -9,20 +9,16 @@ this notice are preserved. This file is offered as-is, without any warranty.
|
||||||
# README
|
# README
|
||||||
|
|
||||||
[![Build Status](https://drone.cismon.net/api/badges/CismonX/ctlseqs/status.svg)](https://drone.cismon.net/CismonX/ctlseqs)
|
[![Build Status](https://drone.cismon.net/api/badges/CismonX/ctlseqs/status.svg)](https://drone.cismon.net/CismonX/ctlseqs)
|
||||||
[![LICENSE](https://img.shields.io/badge/license-GPL--3.0--or--later-blue.svg)](COPYING)
|
[![License](https://img.shields.io/badge/license-GPL--3.0--or--later-blue.svg)](COPYING)
|
||||||
|
|
||||||
ctlseqs - helper library for terminal control sequences
|
|
||||||
|
|
||||||
## About
|
## About
|
||||||
|
|
||||||
The ctlseqs library provides C API for manipulating terminal emulators with control sequences.
|
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.
|
||||||
|
|
||||||
ctlseqs is free software. you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
|
|
||||||
|
|
||||||
## Getting Started
|
## Getting Started
|
||||||
|
|
||||||
To install and use the library, see [INSTALL.md](INSTALL.md) for details.
|
For installation instructions, see [INSTALL.md](INSTALL.md).
|
||||||
|
|
||||||
For documentation, see the [**ctlseqs**(7)](man/ctlseqs.7) man page, and also [*XTerm Control Sequences*](https://invisible-island.net/xterm/ctlseqs/ctlseqs.html) if you're unfamiliar with them.
|
[Documentation](doc/ctlseqs.texi) of the library can be read [online](.), or read with `info ctlseqs` after installation.
|
||||||
|
|
||||||
Some [examples](examples) are provided to demonstrate the basic usage of this library.
|
Some [examples](examples) are provided to demonstrate the basic usage of this library.
|
||||||
|
|
|
@ -7,10 +7,11 @@ dnl this notice are preserved. This file is offered as-is, without any warranty.
|
||||||
dnl
|
dnl
|
||||||
|
|
||||||
AC_PREREQ([2.60])
|
AC_PREREQ([2.60])
|
||||||
AC_INIT([ctlseqs], [0.01], [bug-report@cismon.net])
|
AC_INIT([ctlseqs], [0.1.0], [bug-report@cismon.net])
|
||||||
AC_CONFIG_SRCDIR([src/ctlseqs.c])
|
AC_CONFIG_SRCDIR([src/ctlseqs.c])
|
||||||
AC_CONFIG_HEADERS([config.h])
|
AC_CONFIG_HEADERS([config.h])
|
||||||
AM_INIT_AUTOMAKE([foreign])
|
AM_INIT_AUTOMAKE([foreign])
|
||||||
|
AM_EXTRA_RECURSIVE_TARGETS([install-man uninstall-man])
|
||||||
LT_PREREQ([2.4.0])
|
LT_PREREQ([2.4.0])
|
||||||
LT_INIT
|
LT_INIT
|
||||||
|
|
||||||
|
|
|
@ -6,6 +6,8 @@
|
||||||
# this notice are preserved. This file is offered as-is, without any warranty.
|
# this notice are preserved. This file is offered as-is, without any warranty.
|
||||||
#
|
#
|
||||||
|
|
||||||
|
AUTOMAKE_OPTIONS = no-installman
|
||||||
|
|
||||||
dist_man3_MANS = \
|
dist_man3_MANS = \
|
||||||
ctlseqs_matcher_init.3 \
|
ctlseqs_matcher_init.3 \
|
||||||
ctlseqs_matcher_config.3 \
|
ctlseqs_matcher_config.3 \
|
||||||
|
|
Loading…
Reference in New Issue