Update README files.
continuous-integration/drone/push Build is passing
Details
continuous-integration/drone/push Build is passing
Details
This commit is contained in:
parent
0ebf2b4f1b
commit
116b74ff19
12
INSTALL.md
12
INSTALL.md
|
@ -6,17 +6,20 @@ permitted in any medium without royalty, provided the copyright notice and
|
|||
this notice are preserved. This file is offered as-is, without any warranty.
|
||||
-->
|
||||
|
||||
# INSTALL
|
||||
# Installing ctlseqs
|
||||
|
||||
## Copy Code to Your Project
|
||||
|
||||
The code of ctlseqs is simple, and can be used out-of-the-box. Just copy [ctlseqs.h](include/ctlseqs.h) and [ctlseqs.c](src/ctlseqs.c) to your project and build it alongside with other code.
|
||||
The code of ctlseqs is simple, and can be used out-of-the-box. Just copy
|
||||
[ctlseqs.h](include/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.
|
||||
|
||||
## Build and Install From Source
|
||||
|
||||
Alternatively, ctlseqs can be built into a shared/static library with GNU Autotools (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
|
||||
autoreconf --install
|
||||
|
@ -31,4 +34,5 @@ make check
|
|||
make install
|
||||
```
|
||||
|
||||
Unix man pages are not automatically installed with `make install`, and should be installed manually with `make install-man`.
|
||||
Unix man pages are not automatically installed with `make install`, and should
|
||||
be installed manually with `make install-man`.
|
||||
|
|
|
@ -6,10 +6,11 @@ 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
|
||||
# ctlseqs
|
||||
|
||||
[![Build Status](https://shields.io/drone/build/CismonX/ctlseqs?server=https%3A%2F%2Fdrone.cismon.net)](https://drone.cismon.net/CismonX/ctlseqs)
|
||||
[![License](https://img.shields.io/badge/license-GPL--3.0--or--later-blue.svg)](COPYING)
|
||||
[![Savannah](https://img.shields.io/badge/hosted_on-Savannah-pink)](https://sv.gnu.org/p/ctlseqs)
|
||||
|
||||
## About
|
||||
|
||||
|
@ -20,6 +21,5 @@ which is commonly used for communication between terminal emulators and text-bas
|
|||
|
||||
For installation instructions, see [INSTALL.md](INSTALL.md).
|
||||
|
||||
Documentation 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.
|
||||
Documentation of the library can be read [online](https://nongnu.org/ctlseqs/manual), or read with `info ctlseqs` after installation.
|
||||
Unix man pages are also available.
|
||||
|
|
Loading…
Reference in New Issue