| 1 |
# `barracuda` project |
| 2 |
|
| 3 |
This is a pure Lua library for drawing barcode symbols. `barracuda` components' |
| 4 |
are able to typeset barcode from within a LuaTeX document in order to produce a |
| 5 |
PDF file, or is also possible to use a Lua standalone interpreter to draw |
| 6 |
barcodes in different graphic format such as `SVG` (see an example below). |
| 7 |
|
| 8 |
 |
| 9 |
|
| 10 |
The internal modules are structured to ensure good performance beside of a |
| 11 |
complete user control over barcode symbol parameters :thumbsup: |
| 12 |
|
| 13 |
Although development is in beta stage, `barracuda` has a good level of |
| 14 |
stability. The package does not have any dependences. |
| 15 |
|
| 16 |
## Current version |
| 17 |
|
| 18 |
Version: 0.0.12 - Date: 2022-06-23 |
| 19 |
|
| 20 |
## Barcode symbologies list |
| 21 |
|
| 22 |
So far, the barcode symbologies supported by the package are: |
| 23 |
|
| 24 |
- Code 39 |
| 25 |
- Code 128 |
| 26 |
- Interleaved 2 of 5 (ITF14, i2of5 general) |
| 27 |
- EAN family (ISBN, ISSN, EAN8, EAN13, and the add-ons EAN5 and EAN2) |
| 28 |
- UPC-A |
| 29 |
|
| 30 |
Other 1D encoding symbology will be eventually added to the project, then it |
| 31 |
will be the turn of 2D barcode types like Datamatrix, QRCode or PDF417. |
| 32 |
|
| 33 |
## A very simple LaTeX example |
| 34 |
|
| 35 |
The LaTeX package `barracuda.sty` under the cover uses Lua code so you need to |
| 36 |
compile your source files with LuaTeX or LuajitTeX with the LaTeX format. |
| 37 |
|
| 38 |
For instance, the follow is a minimal working example for LuaLaTeX: |
| 39 |
|
| 40 |
```latex |
| 41 |
% !TeX program = LuaLaTeX |
| 42 |
\documentclass{article} |
| 43 |
\usepackage{barracuda} |
| 44 |
\begin{document} |
| 45 |
\barracuda{code39}{123ABC} |
| 46 |
\end{document} |
| 47 |
``` |
| 48 |
|
| 49 |
## Documentation |
| 50 |
|
| 51 |
Details and package reference can be found in the manual delivered in the `doc` |
| 52 |
project directory, even if actually it is very minimal at the moment. |
| 53 |
|
| 54 |
Directory `test` contains files useful also for code examples. |
| 55 |
|
| 56 |
## Installation |
| 57 |
|
| 58 |
The `barracuda` package can be used with pure Lua interpreter or from within a |
| 59 |
TeX source file for Lua-powered typesetting engine like LuaTeX. In the first |
| 60 |
case you can manually copy `src` folder content to a suitable directory of |
| 61 |
your system. Otherwise, you can install the package via `tlmgr` for your TeX |
| 62 |
Live distribution. |
| 63 |
|
| 64 |
If you have installed TeX Live with the `full` schema, `barracuda` is just |
| 65 |
available and no further action is required. Please, take into account that |
| 66 |
only the tagged version (in the `git` sense) of the package will be sent to |
| 67 |
CTAN. This means that intermediate development version between consecutive |
| 68 |
releases can be found only at <https://github.com/robitex/barracuda> . |
| 69 |
|
| 70 |
TeX Live distribution or Lua interpreter executable are available for a very |
| 71 |
large number of Operating Systems so it is also for `barracuda`. |
| 72 |
|
| 73 |
Step by step instruction can be found in the INSTALL.txt file. |
| 74 |
|
| 75 |
## Contribute |
| 76 |
|
| 77 |
Contributes are welcome in any form and for any topics. You can contact me |
| 78 |
directly via email at [email protected] or via a pull request direct to |
| 79 |
the repository <https://github.com/robitex/barracuda> or writing a public |
| 80 |
message via the web page <https://github.com/robitex/barracuda/issues> for |
| 81 |
todos, bugs, feature requests, and more (press the bottom `New issue`). |
| 82 |
|
| 83 |
Anyway, as a starting point take a look of PLANNER.txt file for the development |
| 84 |
program. |
| 85 |
|
| 86 |
## License |
| 87 |
|
| 88 |
`barracuda` project is released under the |
| 89 |
[GNU GPL v2](https://www.gnu.org/licenses/old-licenses/gpl-2.0.html). |
| 90 |
Please, for more legal details refer to LICENSE.txt file or visit the web page |
| 91 |
<https://www.gnu.org/licenses/old-licenses/gpl-2.0.html> |
| 92 |
|
| 93 |
Copyright (C) 2019-2022 Roberto Giacomelli |