summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/lstfiracode/README.md
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2018-12-17 21:31:58 +0000
committerKarl Berry <karl@freefriends.org>2018-12-17 21:31:58 +0000
commitb3d70195571fd3e8127732f8d3d59f47e2805b8f (patch)
treed1b0ccb78f9f004a8846c9e227428b8b4cf6b40b /Master/texmf-dist/doc/latex/lstfiracode/README.md
parent255b2da802e19c1dae20b2d8fd1a050e0616b845 (diff)
lstfiracode (17dec18)
git-svn-id: svn://tug.org/texlive/trunk@49440 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/lstfiracode/README.md')
-rw-r--r--Master/texmf-dist/doc/latex/lstfiracode/README.md51
1 files changed, 51 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/lstfiracode/README.md b/Master/texmf-dist/doc/latex/lstfiracode/README.md
new file mode 100644
index 00000000000..19a6a8a161b
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/lstfiracode/README.md
@@ -0,0 +1,51 @@
+lstfiracode
+===========
+
+The `lstfiracode` package defines `FiraCodeStyle`, to be used as
+`\lstset{style=FiraCodeStyle}` with the [`listings`](https://ctan.org/pkg/listings)
+package. This style contains almost all ligatures in Nikita Prokopov’s
+[Fira Code](https://github.com/tonsky/FiraCode) family of fonts.
+A new key `moreliterate` to `\lstset` is added, allowing additional user ligatures.
+Additional support for source code listings using Fira Code
+in the `verbatim` environment is available.
+
+This package does NOT provide the Fira Code font files.
+The newest version of the font files can be downloaded at the
+[GitHub Fira Code Releases page](https://github.com/tonsky/FiraCode/releases).
+Here is a sample preamble of a document:
+
+ \documentclass{article}
+ \usepackage{fontspec}
+ \setmonofont{FiraCode-Regular.otf}[Ligatures=Common,Contextuals=Alternate]
+ \usepackage{listings}
+ \usepackage[verbatim]{lstfiracode}
+ \lstset{style=FiraCodeStyle,basicstyle=\ttfamily}
+
+Contributing
+------------
+
+This package is maintained at https://github.com/RuixiZhang42/lstfiracode
+
+Issues and pull requests are welcome.
+
+Copyright and Licence
+---------------------
+
+ Copyright (C) 2018 by Ruixi Zhang <ruixizhang42@gmail.com>
+
+ This work may be distributed and/or modified under the
+ conditions of the LaTeX Project Public License, either version 1.3c
+ of this license or (at your option) any later version.
+ The latest version of this license is in
+ https://www.latex-project.org/lppl.txt
+ and version 1.3c or later is part of all distributions of LaTeX
+ version 2005/12/01 or later.
+
+ This work has the LPPL maintenance status `maintained'.
+
+ The Current Maintainer of this work is Ruixi Zhang.
+
+ This work consists of the files lstfiracode.sty,
+ lstfiracode.tex,
+ README.md (this file)
+ and the derived file lstfiracode.pdf. \ No newline at end of file