diff options
author | Norbert Preining <norbert@preining.info> | 2019-09-02 13:46:59 +0900 |
---|---|---|
committer | Norbert Preining <norbert@preining.info> | 2019-09-02 13:46:59 +0900 |
commit | e0c6872cf40896c7be36b11dcc744620f10adf1d (patch) | |
tree | 60335e10d2f4354b0674ec22d7b53f0f8abee672 /macros/latex/contrib/doclicense/README |
Initial commit
Diffstat (limited to 'macros/latex/contrib/doclicense/README')
-rw-r--r-- | macros/latex/contrib/doclicense/README | 56 |
1 files changed, 56 insertions, 0 deletions
diff --git a/macros/latex/contrib/doclicense/README b/macros/latex/contrib/doclicense/README new file mode 100644 index 0000000000..3f5c248537 --- /dev/null +++ b/macros/latex/contrib/doclicense/README @@ -0,0 +1,56 @@ +LaTeX package 'doclicense' +~~~~~~~~~~~~~~~~~~~~~~~~~~ +Copyright (C) 2015-2019 by Robin Schneider <ypid@riseup.net> + +This work may be distributed and/or modified under the +conditions of the LaTeX Project Public License, either version 1.3 +of this license or (at your option) any later version. +The latest version of this license is in + http://www.latex-project.org/lppl.txt +and version 1.3 or later is part of all distributions of LaTeX +version 2005/12/01 or later. + +CTAN: https://www.ctan.org/pkg/doclicense +Code repository: https://github.com/ypid/latex-packages/tree/master/doclicense + +Question on Stackexchange: https://tex.stackexchange.com/a/226788/32320 + + + DESCRIPTION +Support for putting documents under a license. + +The doclicense package allows you to put your document under a license and include a link +to read about the license or include an icon or image of the license. +Currently, only Creative Commons is supported but this package is designed to +handle all kinds of licenses. + + GENERATING THE FILES +You can generate the doclicense.sty file with: tex doclicense.ins + +The documentation can be generated with: + + pdflatex doclicense.dtx + makeindex -s gglo.ist -o doclicense.gls doclicense.glo + makeindex -s gind doclicense + pdflatex doclicense.dtx + thumbpdf doclicense + pdflatex doclicense.dtx + +Note that this will only work when this directory is below your +$TEXMFHOME tree (unless the doclicense package is already installed +for example by your TeX distribution). Example for doing this manually: + + mkdir --parents ~/texmf/tex/latex/ && cd ~/texmf/tex/latex/ + git clone https://github.com/ypid/latex-packages.git ypid-latex-packages + cd ypid-latex-packages/doclicense && make build + ## Or + make all + +If you have not worked with $TEXMFHOME you might want to refer to the +documentation of your TeX distribution for details. See also the next section. + + IMPORTANT NOTES REGARDING TDS + +Please note that the images/ and the license-texts/ subdirectories must end up in the runtime tex/ +subtree (that is tex/latex/doclicense/) for the \doclicenseImage macro and the \doclicense*FullText macros to work +correctly. |