Debian Codegraph @

texmf-dist/doc/lualatex/fancymag/README.md

raw
1 # fancymag
2
3 # Particle Style – A Custom LaTeX Package
4
5 **Authors:** Ashadul Halder and Soumik Ghosh
6 **License:** LPPL v1.3c (fonts under SIL Open Font License v1.1)
7 **Font License:** SIL Open Font License v1.1
8
9 ---
10
11 ## Overview
12
13 `fancymag.sty` is a LaTeX package designed to provide enhanced typographic styling using a set of freely licensed display fonts. It enables you to integrate modern, visually striking fonts into your LaTeX documents with ease, making it ideal for academic magazines, scientific books, and editorial publications.
14
15 ---
16
17 ## Features
18
19 - Custom font commands for stylish text
20 - Uses 7 modern fonts with full Unicode support:
21 - Audiowide
22 - Fira Mono
23 - Imperial Script
24 - Montserrat
25 - Rationale
26 - Orbitron
27 - Oleo Script Swash Caps
28 - Works with LuaLaTeX
29 - Easily portable (fonts are bundled locally)
30
31 ---
32
33 ## Note on Font Installation
34
35 This package is designed to work with **LuaLaTeX** and uses locally bundled fonts. These fonts are stored in the `fonts/` directory and are not installed system-wide.
36
37 If installed via TeX Live or MiKTeX, the fonts may not be available by default. Users must compile in a directory where the `fonts/` folder is present.
38
39 This design keeps the package portable and self-contained, but it limits automatic compatibility with TeX package managers.
40
41 ## Requirements
42
43 This package must be compiled using **LuaLaTeX**.
44
45 It uses system-independent OpenType fonts via `fontspec` and will not work with `pdflatex` or `xelatex`.
46
47 Ensure that the `fonts/` folder (included with the package) is present in the same directory or properly referenced.
48
49
50 ## Getting Started
51
52 To use the package:
53
54 1. Add `\usepackage{fancymag}` to your LaTeX document.
55 2. Compile using **LuaLaTeX** (fontspec required).
56
57 See the full tutorial in the file: **`fancymag.pdf`**
58
59 ## Font Licenses
60
61 This package includes the following fonts, all licensed under the **SIL Open Font License (OFL) v1.1**:
62
63 - Audiowide
64 - Fira Mono
65 - Imperial Script
66 - Montserrat
67 - Rationale
68 - Orbitron
69 - Oleo Script Swash Caps
70
71 The full text of the OFL v1.1 license is included in the package as `OFL.txt`.
72
73 ---
74
75 ## Files Included
76
77 - `fancymag.sty` – Main package file
78 - `fancymag-doc.tex` – Documentation source
79 - `fancymag-doc.pdf` – Compiled documentation
80 - `README.md` – This file
81 - `fonts/` – Directory containing all required fonts
82 - `img/` – Directory containing all required graphics
83 - `OFL.txt` – Font license (SIL Open Font License v1.1)
84 - `LICENSE.txt` – Package license (LPPL v1.3c)
85
86 ---
87
88 ## Version History
89
90 - **v1.0** – Initial release (2025-07-07)