summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/fixmetodonotes/README
blob: 46d9aca6e1e90ee19e4f50b3aa7ef15d6605756f (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
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
fixmetodonotes
==============

A LaTeX package to highlight and manage FIXME and TODO annotations.


Usage
-----

In the preamble add

    \usepackage{fixmetodonotes}

In the document write notes using

    I believe that in the \FIXME{"next year" or "future"?} the revolution
    will not be televised.

or

    \TODO{add a playful picture}

To show a list of pending notes, together with links to their pages, use

    \listofnote

The list of notes will be shown like a table of content or a list of figures.


Installation
------------

The released archives can be installed using the standard LaTeX mechanism.

    latex fixmetodonotes.ins

This will generate a `fixmetodonotes.sty` file that can be moved to a
directory searched by TeX.

You can also install `fixmetodonotes` in your home directory using the
git repository.

    export TEXMFHOME=~/.texmf
    mkdir -p ~/.texmf/tex/latex/
    cd ~/.texmf/tex/latex/
    git clone git://github.com/gioele/fixmetodonotes.git


Authors
-------

* Gioele Barabucci <http://svario.it/gioele> (initial author)


License
-------

This is free software released into the public domain (CC0 license).

See the `LICENSE` file or <http://creativecommons.org/publicdomain/zero/1.0/>
for more details.