summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/to-be-determined/README.md
blob: 26adf210daea2b8ddf5781f9dfdd8597f656b6e3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
[![make](https://github.com/yegor256/to-be-determined/actions/workflows/latexmk.yml/badge.svg)](https://github.com/yegor256/to-be-determined/actions/workflows/latexmk.yml)
[![License](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/yegor256/to-be-determined/blob/master/LICENSE.txt)

This LaTeX package helps you highlight pieces of your code that needs
further work (TBD stands for "to be determined"). 
The package uses [`xcolor`](https://ctan.org/pkg/minted) 
and [`soul`](https://ctan.org/pkg/soul) packages.

First, [install it](https://en.wikibooks.org/wiki/LaTeX/Installing_Extra_Packages)
from [CTAN](https://ctan.org/pkg/to-be-determined) 
and then use in the preamble:

```tex
\documentclass{article}
\usepackage{to-be-determined}
\begin{document}
The budget is \tbd{99.00 USD}.
\end{document}
```

The full example and all commands are available in the 
[`to-be-determined.tex`](https://github.com/yegor256/to-be-determined/blob/master/to-be-determined.tex) file.

If you want to contribute yourself, make a fork, then create a branch, 
then run `make` in the root directory.
It should compile everything without errors. If not, submit an issue and wait.
Otherwise, make your changes and then run `make` again. If the build is
still clean, submit a pull request.