2020-11-17 06:24:43 +00:00
|
|
|
#
|
|
|
|
|
# Copyright (C) 2020 CismonX <admin@cismon.net>
|
|
|
|
|
#
|
|
|
|
|
# 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.
|
|
|
|
|
#
|
|
|
|
|
|
|
|
|
|
#+TITLE: Installation Guidelines
|
|
|
|
|
|
|
|
|
|
** Copy Library Code to Your Project
|
|
|
|
|
|
|
|
|
|
This is the recommended way to use this library. Just copy [[file:src/ctlseqs.h][ctlseqs.h]] and
|
2020-11-27 01:23:12 +00:00
|
|
|
[[file:src/ctlseqs.c][ctlseqs.c]] to your project and build it alongside with other code.
|
2020-11-17 06:24:43 +00:00
|
|
|
|
2020-11-27 01:23:12 +00:00
|
|
|
Requires an ISO C99 and POSIX.1-2008 compliant C implementation.
|
2020-11-17 06:24:43 +00:00
|
|
|
|
|
|
|
|
** Build and Install From Source
|
|
|
|
|
|
|
|
|
|
Alternatively, You may want a systemwide installation of the library and
|
|
|
|
|
link it to your project. Some scripts are provided to help you with that.
|
|
|
|
|
|
2020-11-27 01:23:12 +00:00
|
|
|
Requires GNU Autoconf, Automake, Libtool and Autoconf Archive.
|
2020-11-17 06:24:43 +00:00
|
|
|
|
|
|
|
|
#+BEGIN_SRC shell
|
|
|
|
|
autoreconf --install
|
|
|
|
|
./configure --prefix=$HOME CFLAGS='-O0 -g'
|
|
|
|
|
#+END_SRC
|
|
|
|
|
|
|
|
|
|
Compile the library source code, as well as [[file:examples][examples]] and test suites.
|
|
|
|
|
Optionally, you can run the test suite (requires DejaGnu), install the
|
2020-11-27 01:23:12 +00:00
|
|
|
binary and man pages.
|
2020-11-17 06:24:43 +00:00
|
|
|
|
|
|
|
|
#+BEGIN_SRC shell
|
|
|
|
|
make && make check && make install
|
|
|
|
|
#+END_SRC
|
|
|
|
|
|
|
|
|
|
Finally, link it to your project with the ~-lctlseqs~ (or similar) flag.
|
|
|
|
|
|
|
|
|
|
** 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
|
|
|
|
|
|
|
|
|
|
#+BEGIN_SRC shell
|
|
|
|
|
brew tap CismonX/repos
|
|
|
|
|
brew install ctlseqs
|
|
|
|
|
#+END_SRC
|
