summaryrefslogtreecommitdiff
path: root/fonts/lexend/README.md
blob: 58f9e049f9c8b4a03a3c0c03dabcc64479d471f3 (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
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
# latex-lexend

The [Lexend fonts](https://www.lexend.com/) for XeLaTeX and LuaLaTeX through fontspec

<!-- TOC depthFrom:2 depthTo:6 withLinks:1 updateOnSave:1 orderedList:0 -->

- [Dowloading](#dowloading)
- [Working with the Source Code](#working-with-the-source-code)
	- [Cloning](#cloning)
	- [Building](#building)
		- [Prerequisites](#prerequisites)
		- [Making the Package](#making-the-package)
	- [Developing](#developing)
- [License](#license)
- [Random Quote](#random-quote)

<!-- /TOC -->

## Dowloading

You can find this package on[CTAN](https://ctan.org/): https://ctan.org/pkg/lexend

## Working with the Source Code

### Cloning

To clone this repo, be sure to clone it recursively:

```sh
git clone --recursive https://github.com/BrainStone/latex-lexend.git
```

For older git versions or if you forgot to clone it recursively, do it like this:

```sh
git clone https://github.com/BrainStone/latex-lexend.git
cd latex-lexend
git submodule update --init --recursive
```

### Building

#### Prerequisites

Before you try to build this package make sure you have the following installed:

- `make`
- `pandoc`
- A working TeX environment with a working `latexmk` and `lualatex` command.
- `git` (Yes, `git` is used to determine the version number automatically. So if you want it build properly, you need it, if you don't care about that, it's
  not needed)

#### Making the Package

Now if you just want to build the package, run:

```sh
make
```

Removing the build directory after creating the package can be done with

```sh
make clean
```

### Developing

If you wish to work on this package, be sure to clone it as described and also to run this command to set everything up:

```sh
make setupWorkspace
```

## License

The licensing of this project is a bit uncommon, so let me explain:

The source repository, the one you find under https://github.com/BrainStone/latex-lexend, however is licensed under the
[GNU General Public License v3.0](https://www.gnu.org/licenses/gpl-3.0.html).

The final package, the one you find on [CTAN](https://ctan.org/), is licensed under [The LaTeX Project Public License 1.3c](https://ctan.org/license/lppl1.3c).
So use it like you would use most other packages on [CTAN](https://ctan.org/).

Lastly, the font collection itself is licensed under the [SIL Open Font License 1.1](https://opensource.org/licenses/OFL-1.1). You can find the license file
under https://github.com/ThomasJockin/lexend/blob/master/OFL.txt.

## Random Quote

> Hardware: The parts of a computer system that can be kicked.
>
> <cite>Jeff Pesis</cite>