File: README.md

package info (click to toggle)
r-cran-textshaping 0.2.1-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye
  • size: 272 kB
  • sloc: cpp: 1,320; sh: 59; ansic: 52; makefile: 2
file content (47 lines) | stat: -rw-r--r-- 1,729 bytes parent folder | download
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

<!-- README.md is generated from README.Rmd. Please edit that file -->

# textshaping

<!-- badges: start -->

[![Codecov test
coverage](https://codecov.io/gh/r-lib/textshaping/branch/master/graph/badge.svg)](https://codecov.io/gh/r-lib/textshaping?branch=master)
[![R build
status](https://github.com/r-lib/textshaping/workflows/R-CMD-check/badge.svg)](https://github.com/r-lib/textshaping/actions)
<!-- badges: end -->

This package is a low level package that provides advanced text shaping
capabilities to graphic devices. It is based on the
[FriBidi](https://github.com/fribidi/fribidi) and
[HarfBuzz](https://harfbuzz.github.io) libraries and provides full
support for correctly shaping left-to-right, right-to-left, and
bidirectional text with full support for all OpenType features such as
ligatures, stylistic glyph substitutions, etc.

For an example of a package that uses textshaping to support advanced
text layout see [ragg](https://ragg.r-lib.org).

A big thanks to [Behdad Esfahbod](http://behdad.org) who is the main
author of both FriBidi and HarfBuzz and has been very helpful answering
questions during the cause of development.

## Installation

You can install textshaping from CRAN with
`install.packages("textshaping")`. For the development version you can
install it from Github with devtools:

``` r
devtools::install_github("r-lib/textshaping")
```

Note that you will need both the development versions of FriBidi and
HarfBuzz to successfully compile it.

## Code of Conduct

Please note that the textshaping project is released with a [Contributor
Code of
Conduct](https://contributor-covenant.org/version/2/0/CODE_OF_CONDUCT.html).
By contributing to this project, you agree to abide by its terms.