Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 31 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -191,9 +191,23 @@ lint-zh:
ba-guide:$(VERSION) \
/bin/sh -c "chktex ${srcdir}/*-zh.tex; exit 0"

PHONY: lint-fa
lint-fa:
@echo "==========================================="
@echo "= linting Persian Guide ="
@echo "==========================================="
@docker run \
--rm \
-ti \
-v $(shell pwd):/guide:rw \
-w /guide \
--hostname ba-guide \
ba-guide:$(VERSION) \
/bin/sh -c "chktex ${srcdir}/*-fa.tex; exit 0"

# run the latex linting tool
.PHONY: lint
lint: lint-de lint-el lint-en lint-es lint-fr lint-it lint-pt-br lint-ru lint-tr lint-zh
lint: lint-de lint-el lint-en lint-es lint-fa lint-fr lint-it lint-pt-br lint-ru lint-tr lint-zh

# generate pdf per language
.PHONY: pdf-de
Expand Down Expand Up @@ -256,6 +270,21 @@ pdf-es:
lualatex \
${srcdir}/blackarch-guide-es.tex 1>>./build_log_es"

.PHONY: pdf-fa
pdf-fa:
@echo "Compiling Persian guide - output in build_log_fa"
@docker run \
--rm \
-ti \
-v $(shell pwd):/guide:rw \
-w /guide \
--hostname ba-guide \
ba-guide:$(VERSION) \
/bin/sh -c "lualatex \
${srcdir}/blackarch-guide-fa.tex 1>./build_log_fa; \
lualatex \
${srcdir}/blackarch-guide-fa.tex 1>>./build_log_fa"

.PHONY: pdf-fr
pdf-fr:
@echo "Compiling French guide - output in build_log_fr"
Expand Down Expand Up @@ -363,4 +392,4 @@ pdf-zh:

# generate for all languages
.PHONY: pdf
pdf: pdf-de pdf-el pdf-en pdf-es pdf-fr pdf-it pdf-pt-br pdf-ru pdf-tr pdf-zh
pdf: pdf-de pdf-el pdf-en pdf-es pdf-fa pdf-fr pdf-it pdf-pt-br pdf-ru pdf-tr pdf-zh
31 changes: 16 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,41 +3,42 @@
This is part of BlackArch Linux and provides the latex files for the BlackArch
User Guides.

To create a new Guide in in a language create a
blackarch-guide-<your-country-code>.tex and an appendex-<your-country-code>.tex
To create a new Guide in in a language create a
blackarch-guide-`<your-country-code>`.tex and an appendex-`<your-country-code>`.tex
file in the latex directory and add the
target to the ```Makefile```.

target to the ``Makefile``.

Everything is compiled in a Docker container, so the only dependency
needed is docker.

-------
---

### Build
To compile the guides run
```make docker-build```
```make pdf```

This will compile all guides listed as targets in the ```Makefile```.
To compile the guides run
``make docker-build``
``make pdf``

This will compile all guides listed as targets in the ``Makefile``.

##### Current Targets are:

* de
* el
* en
* es
* fr
* fa
* fr
* it
* pt-br
* ru
* tr
* zh

You can also build a single guide (e.g. German)
```make pdf-de```
``make pdf-de``

linting is done via
``` make lint```
or for a subtarget (e.g. English)
```make lint-en```

`` make lint``
or for a subtarget (e.g. English)
``make lint-en``
Loading