summaryrefslogtreecommitdiff
path: root/macros/luatex/generic/barracuda/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'macros/luatex/generic/barracuda/README.md')
-rw-r--r--macros/luatex/generic/barracuda/README.md42
1 files changed, 30 insertions, 12 deletions
diff --git a/macros/luatex/generic/barracuda/README.md b/macros/luatex/generic/barracuda/README.md
index e4ca271287..6dc3ccb2db 100644
--- a/macros/luatex/generic/barracuda/README.md
+++ b/macros/luatex/generic/barracuda/README.md
@@ -3,8 +3,8 @@
This Lua library is for drawing barcode symbols. The project delivers modules
to typeset barcode from within a LuaTeX document. Therefore is also possible
to use `barracuda` with a Lua standalone interpreter to draw barcodes with
-different graphic format such as `SVG`.
-The package does not have dependences.
+different graphic format such as `SVG` (see an example below).
+This package does not have dependences.
![a SVG formatted Code39 symbol](/test/test-ga-svg/test-code39.svg)
@@ -14,7 +14,12 @@ complete user control over barcode symbol parameters :thumbsup: .
Although development is in beta stage, `barracuda` has a good level of
stability.
-## Barcode symbologies
+## Current version information
+
+Version: v0.0.9.1
+Date: 2019-12-04
+
+## Barcode symbologies list
So far, are supported
@@ -23,15 +28,15 @@ So far, are supported
- Interleaved 2 of 5
- EAN family (EAN8, EAN13, and the add-ons EAN5 and EAN2)
-Other 1D encoding format will be added to the project, then it will be the
-turn for 2D barcode type.
+Other 1D encoding symbology will be added to the project, then it will be the
+turn of 2D barcode types like Datamatrix, QRCode or PDF417.
## A very simple LaTeX example
The LaTeX package `barracuda.sty` under the cover uses Lua code so you need to
compile your source files with LuaTeX or LuajitTeX with the LaTeX format.
-For instance here there is a minimal example for LuaLaTeX:
+For instance, here there is a minimal example for LuaLaTeX:
```latex
% !TeX program = LuaLaTeX
@@ -47,7 +52,7 @@ For instance here there is a minimal example for LuaLaTeX:
Details and package reference can be found in the manual delivered in the `doc`
project directory, even if it is very minimal at the moment.
-The directory `test` contains files that can be seen as code examples.
+Directory `test` contains files useful also for code examples.
## Installation
@@ -58,20 +63,33 @@ your system. Otherwise, you can install the package via `tlmgr` for your TeX
Live distribution.
If you have installed TeX Live with the `full` schema, `barracuda` is just
-available and no further action is required because the last package tagged
-version is periodically sent to CTAN.
+available and no further action is required. Please, take into account that
+only the tagged version (in the `git` sense) of the package will be sent to
+CTAN. This means that intermediate development version between consecutive
+releases can be found only at https://github.com/robitex/barracuda .
TeX Live distribution or Lua interpreter executable are available for a very
large number of Operating Systems so it is also for `barracuda`.
-More detailed istruction will come soon.
+Step by step istruction can be found in the INSTALL.txt file.
## Contribute
-Contributes are welcome in any form and for any topics.
+Contributes are welcome in any form and for any topics. You can contact me
+directly via email at giaconet.mailbox@gmail.com or via a pull request on the
+repository https://github.com/robitex/barracuda or writing a public message
+via the web page https://github.com/robitex/barracuda/issues for todos, bugs,
+feature requests, and more (press the bottom `New issue`).
+
+Anyway, as a starting point take a look of TODO.txt file for the next
+scheduled development tasks.
## License
-Please, for more legal details refer to LICENSE.txt file.
+`barracuda` project is released under the
+[GNU GPL v2](https://www.gnu.org/licenses/old-licenses/gpl-2.0.html).
+Please, for more legal details refer to LICENSE.txt file or visit the web page
+https://www.gnu.org/licenses/old-licenses/gpl-2.0.html
Copyright (C) 2019 Roberto Giacomelli
+