Skip to content

Commit

Permalink
Add documentation of compatibility, addresses #8. Bump copyright
Browse files Browse the repository at this point in the history
  • Loading branch information
duetosymmetry committed Dec 30, 2023
1 parent 8b2e5a3 commit 11f7302
Show file tree
Hide file tree
Showing 5 changed files with 20 additions and 8 deletions.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
LPPL License 1.3c

Copyright (C) 2020 Leo C. Stein <[email protected]>
Copyright (C) 2019-2023 Leo C. Stein <[email protected]>

This work may be distributed and/or modified under the
conditions of the LaTeX Project Public License, either version 1.3
Expand Down
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,21 +30,25 @@ When you want to insert the hyperlinked ORCiD logo, use `\orcidlink{0000-0000-00
This will appear as a clickable hyperlink, and will look like this:
![Author LaTeX render preview image](https://raw.githubusercontent.com/duetosymmetry/orcidlink-LaTeX-command/f03c85cd9fe3e40bec5f51b1319b0e9ab30c2e09/preview.png)

Dependancies
------------
Dependancies and Compatibility
------------------------------

This package relies on the following packages:
- [hyperref](https://www.ctan.org/pkg/hyperref)
- [tikz](https://www.ctan.org/pkg/pgf)

All of these packages are included in the popular [TeX Live](https://www.tug.org/texlive/) distribution, so most users should not have to install anything new.

If you want to pass options to either of these packages, load them
before you load `orcidlink`. Similarly, if you want to specify options
to e.g. `xcolor`, load `xcolor` before loading `tikz` or `orcidlink`.

Credits
-------

The original TikZ icon code was created by user [Milo on
TeX.SE](https://tex.stackexchange.com/users/128068/milo).
This package was created and is maintained by [Leo
C. Stein](http://duetosymmetry.com/), (c) 2019.
C. Stein](http://duetosymmetry.com/), (c) 2019-2023.
This material is subject to the [LaTeX Project Public License
1.3c](https://www.ctan.org/license/lppl1.3).
10 changes: 9 additions & 1 deletion orcidlink.dtx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
% \iffalse meta-comment
%
% Copyright (C) 2020 by Leo C. Stein <[email protected]>
% Copyright (C) 2019-2023 by Leo C. Stein <[email protected]>
% ---------------------------------------------------------------------------
% This work may be distributed and/or modified under the
% conditions of the LaTeX Project Public License, either version 1.3
Expand Down Expand Up @@ -113,6 +113,14 @@
% \includegraphics[width=0.5\textwidth]{preview}\newline{}
% The macro is used in the author line of this documentation as well.
%
% \section{Package Compatibility}
%
% This package relies on \texttt{hyperref} and \texttt{tikz}. If you
% want to pass options to either of these packages, load them
% \emph{before} you load \texttt{orcidlink}. Similarly, if you want
% to specify options to e.g. \texttt{xcolor}, load \texttt{xcolor}
% before loading \texttt{tikz} or \texttt{orcidlink}.
%
% \StopEventually{}
%
% \section{Implementation}
Expand Down
4 changes: 2 additions & 2 deletions orcidlink.ins
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
%% Copyright (C) 2020 by Leo C. Stein <[email protected]>
%% Copyright (C) 2019-2023 by Leo C. Stein <[email protected]>
%% --------------------------------------------------------------------------
%% This work may be distributed and/or modified under the
%% conditions of the LaTeX Project Public License, either version 1.3
Expand All @@ -25,7 +25,7 @@

This is a generated file.

Copyright (C) 2020 by Leo C. Stein <[email protected]>
Copyright (C) 2019-2023 by Leo C. Stein <[email protected]>
--------------------------------------------------------------------------
This work may be distributed and/or modified under the
conditions of the LaTeX Project Public License, either version 1.3
Expand Down
2 changes: 1 addition & 1 deletion orcidlink.sty
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
%%
%% This is a generated file.
%%
%% Copyright (C) 2020 by Leo C. Stein <[email protected]>
%% Copyright (C) 2019-2023 by Leo C. Stein <[email protected]>
%% --------------------------------------------------------------------------
%% This work may be distributed and/or modified under the
%% conditions of the LaTeX Project Public License, either version 1.3
Expand Down

0 comments on commit 11f7302

Please sign in to comment.