summaryrefslogtreecommitdiff
path: root/README.rst
blob: 9040d3d101c0d7092688b7ca1afd6a6275c11f77 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
======
 What
======

The *Letterspace* module for ConTeXt MkIV allows for defining letterspacing
macros.

A prebuilt PDF of the latest manual is available at
https://gitlab.com/phgsng/t-letterspace/wikis/doc

==============
 Installation
==============

Copy the program tree into your local ConTeXt tree, i.e. if you have the
minimals installed inside ``$HOME/context/``, issue the following command from
the module root: ::

    cp -r tex/ ~/context/tex/texmf-local/

Optionally do the same for the documentation tree: ::

    cp -r doc/ ~/context/tex/texmf-local/

Next, update the ConTeXt filename database so that the module can be found: ::

    context --generate

Congratulations, the *Letterspace* module is now ready to use. As a test, chdir
into the documentation directory and build the manual: ::

    cd doc/context/third/letterspace/
    context letterspace.tex

=====
 Who
=====
Written by Philipp Gesang, Tübingen.
Email me (``phg`` at ``phi-gamma`` dot ``net``, see my website_ for details)
or file a tracker item on Gitlab_ if something doesn’t seem right.

=========
 License
=========

The *Letterspace* module is licensed under the terms of the BSD license with two
clauses. See the file ``COPYING`` or the *License* chapter in the manual for
details.

.. _repository: https://gitlab.com/phgsng/t-letterspace/downloads
.. _Gitlab:     https://gitlab.com/phgsng/t-letterspace
.. _website:    https://www.phi-gamma.net