From a426e497565d54ff4d477189296a11396bc746dd Mon Sep 17 00:00:00 2001 From: Yegor Bugayenko Date: Sat, 23 Mar 2024 09:49:18 +0300 Subject: [PATCH] #37 readme --- README.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 36252a3..99b11f2 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,16 @@ +# Fixed-Font LaTeX Primitive: `\ff` and `\begin{ffcode}` + [![make](https://github.com/yegor256/ffcode/actions/workflows/l3build.yml/badge.svg)](https://github.com/yegor256/ffcode/actions/workflows/l3build.yml) [![CTAN](https://img.shields.io/ctan/v/ffcode)](https://ctan.org/pkg/ffcode) [![License](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/yegor256/ffcode/blob/master/LICENSE.txt) This LaTeX package helps you write source code in your academic papers -and make sure it looks neat. The package uses [`listings`](https://ctan.org/pkg/listings) +and make sure it looks neat. The package uses +[`listings`](https://ctan.org/pkg/listings) and [`tcolorbox`](https://ctan.org/pkg/tcolorbox) packages. -First, [install it](https://en.wikibooks.org/wiki/LaTeX/Installing_Extra_Packages) +First, +[install it](https://en.wikibooks.org/wiki/LaTeX/Installing_Extra_Packages) from [CTAN](https://ctan.org/pkg/ffcode) and then use in the preamble: @@ -23,7 +27,9 @@ void r() { \end{document} ``` -Otherwise, you can download [`ffcode.sty`](https://yegor256.github.io/ffcode/ffcode.sty) and add to your project. +Otherwise, you can download +[`ffcode.sty`](https://yegor256.github.io/ffcode/ffcode.sty) and +add to your project. If you want to contribute yourself, make a fork, then create a branch, then run `l3build ctan` in the root directory.