Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Switched from addHeader to annotate in the tutorial #69

Closed
wants to merge 2 commits into from
Closed

Switched from addHeader to annotate in the tutorial #69

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4dbcd03
Updated site to use correct annotate command
benji-lewis Jun 7, 2024
eb886f5
Updated translations with correct annotate command
benji-lewis Jun 7, 2024
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
16 changes: 8 additions & 8 deletions site/content/en/tutorial.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,16 +113,16 @@ header information, but of course with corresponding comment syntax.

{{< box-tool >}}

The `reuse addheader` command helps with adding licensing and copyright
The `reuse annotate` command helps with adding licensing and copyright
information to your files. For the task above, the following command
would do the job:

```bash
reuse addheader --copyright="Jane Doe <jane@example.com>" --license="GPL-3.0-or-later" src/main.c Makefile README.md
reuse annotate --copyright="Jane Doe <jane@example.com>" --license="GPL-3.0-or-later" src/main.c Makefile README.md
```

Please see the [tool's documentation about
addheader](https://reuse.readthedocs.io/en/stable/usage.html#addheader)
annotate](https://reuse.readthedocs.io/en/stable/usage.html#annotate)
for more options like comment styles and templates

{{< /box-tool >}}
Expand All @@ -144,11 +144,11 @@ The REUSE helper tool should automatically detect binary files and
therefore automatically create a corresponding `.license` file.

If it does not, or if you would like to enforce this, add the
`--force-dot-license` argument to the addheader command. So the command
`--force-dot-license` argument to the annotate command. So the command
for the above task may look like this:

```bash
reuse addheader --copyright="Jane Doe <jane@example.com>" --license="GPL-3.0-or-later" --force-dot-license img/cat.jpg img/dog.jpg
reuse annotate --copyright="Jane Doe <jane@example.com>" --license="GPL-3.0-or-later" --force-dot-license img/cat.jpg img/dog.jpg
```

{{< /box-tool >}}
Expand All @@ -175,7 +175,7 @@ SPDX-License-Identifier: CC-BY-4.0

The tool as of now does not provide a way to replace existing
REUSE-compliant copyright and licensing information. A run of
the `addheader` command would not replace but extend the `.license`
the `annotate` command would not replace but extend the `.license`
files with two additional lines stating the copyright of Max Mehl and
the CC-BY-4.0 license. So you would have to update these manually.

Expand Down Expand Up @@ -218,10 +218,10 @@ More information about copyrightable files can be found in the [REUSE FAQ]({{< r

{{< box-tool >}}

As before, a combination of the `addheader` and `download` commands will fulfil the above step:
As before, a combination of the `annotate` and `download` commands will fulfil the above step:

```bash
reuse addheader --copyright="Jane Doe <jane@example.com>" --license="CC0-1.0" .gitignore
reuse annotate --copyright="Jane Doe <jane@example.com>" --license="CC0-1.0" .gitignore

reuse download --all
```
Expand Down
40 changes: 20 additions & 20 deletions site/po/cs.po
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2575,30 +2575,30 @@ msgstr ""
#. type: Plain text
#: site/content/en/tutorial.md
msgid ""
"The `reuse addheader` command helps with adding licensing and copyright "
"The `reuse annotate` command helps with adding licensing and copyright "
"information to your files. For the task above, the following command would "
"do the job:"
msgstr ""
"Příkaz `reuse addheader` vám pomůže přidat do souborů informace o licencích "
"Příkaz `reuse annotate` vám pomůže přidat do souborů informace o licencích "
"a autorských právech. Pro výše uvedenou úlohu by tuto úlohu splnil "
"následující příkaz:"

#. type: Fenced code block (bash)
#: site/content/en/tutorial.md
#, no-wrap
msgid "reuse addheader --copyright=\"Jane Doe <jane@example.com>\" --license=\"GPL-3.0-or-later\" src/main.c Makefile README.md\n"
msgstr "reuse addheader --copyright=\"Jane Doe <jane@example.com>\" --license=\"GPL-3.0-or-later\" src/main.c Makefile README.md\n"
msgid "reuse annotate --copyright=\"Jane Doe <jane@example.com>\" --license=\"GPL-3.0-or-later\" src/main.c Makefile README.md\n"
msgstr "reuse annotate --copyright=\"Jane Doe <jane@example.com>\" --license=\"GPL-3.0-or-later\" src/main.c Makefile README.md\n"

#. type: Plain text
#: site/content/en/tutorial.md
msgid ""
"Please see the [tool's documentation about addheader](https://reuse."
"readthedocs.io/en/stable/usage.html#addheader) for more options like "
"Please see the [tool's documentation about annotate](https://reuse."
"readthedocs.io/en/stable/usage.html#annotate) for more options like "
"comment styles and templates"
msgstr ""
"Další možnosti, například styly komentářů a šablony, naleznete v dokumentaci "
"[nástroje addheader](https://reuse.readthedocs.io/en/stable/usage."
"html#addheader)"
"[nástroje annotate](https://reuse.readthedocs.io/en/stable/usage."
"html#annotate)"

#. type: Title ###
#: site/content/en/tutorial.md
Expand Down Expand Up @@ -2646,23 +2646,23 @@ msgstr ""
#, fuzzy
#| msgid ""
#| "If it does not, or if you would like to enforce this, add the `--explicit-"
#| "license` argument to the addheader command. So the command for the above "
#| "license` argument to the annotate command. So the command for the above "
#| "task may look like this:"
msgid ""
"If it does not, or if you would like to enforce this, add the `--force-dot-"
"license` argument to the addheader command. So the command for the above "
"license` argument to the annotate command. So the command for the above "
"task may look like this:"
msgstr ""
"Pokud tomu tak není, nebo pokud chcete tuto povinnost vynutit, přidejte do "
"příkazu addheader argument `--explicit-license`. Příkaz pro výše uvedenou "
"příkazu annotate argument `--explicit-license`. Příkaz pro výše uvedenou "
"úlohu tedy může vypadat takto:"

#. type: Fenced code block (bash)
#: site/content/en/tutorial.md
#, fuzzy, no-wrap
#| msgid "reuse addheader --copyright=\"Jane Doe <jane@example.com>\" --license=\"GPL-3.0-or-later\" --explicit-license img/cat.jpg img/dog.jpg\n"
msgid "reuse addheader --copyright=\"Jane Doe <jane@example.com>\" --license=\"GPL-3.0-or-later\" --force-dot-license img/cat.jpg img/dog.jpg\n"
msgstr "reuse addheader --copyright=\"Jane Doe <jane@example.com>\" --license=\"GPL-3.0-or-later\" --explicit-license img/cat.jpg img/dog.jpg\n"
#| msgid "reuse annotate --copyright=\"Jane Doe <jane@example.com>\" --license=\"GPL-3.0-or-later\" --explicit-license img/cat.jpg img/dog.jpg\n"
msgid "reuse annotate --copyright=\"Jane Doe <jane@example.com>\" --license=\"GPL-3.0-or-later\" --force-dot-license img/cat.jpg img/dog.jpg\n"
msgstr "reuse annotate --copyright=\"Jane Doe <jane@example.com>\" --license=\"GPL-3.0-or-later\" --explicit-license img/cat.jpg img/dog.jpg\n"

#. type: Title ###
#: site/content/en/tutorial.md
Expand Down Expand Up @@ -2715,14 +2715,14 @@ msgstr ""
#: site/content/en/tutorial.md
msgid ""
"The tool as of now does not provide a way to replace existing REUSE-"
"compliant copyright and licensing information. A run of the `addheader` "
"compliant copyright and licensing information. A run of the `annotate` "
"command would not replace but extend the `.license` files with two "
"additional lines stating the copyright of Max Mehl and the CC-BY-4.0 "
"license. So you would have to update these manually."
msgstr ""
"Nástroj zatím neposkytuje způsob, jak nahradit stávající informace o "
"autorských právech a licencích v souladu s nařízením REUSE. Spuštění příkazu "
"`addheader` by nenahradilo, ale rozšířilo by soubory `.license` o dva další "
"`annotate` by nenahradilo, ale rozšířilo by soubory `.license` o dva další "
"řádky uvádějící autorská práva Maxe Mehla a licenci CC-BY-4.0. Ty byste tedy "
"museli aktualizovat ručně."

Expand Down Expand Up @@ -2824,21 +2824,21 @@ msgstr ""
#. type: Plain text
#: site/content/en/tutorial.md
msgid ""
"As before, a combination of the `addheader` and `download` commands will "
"As before, a combination of the `annotate` and `download` commands will "
"fulfil the above step:"
msgstr ""
"Stejně jako dříve splní výše uvedený krok kombinace příkazů `addheader` a "
"Stejně jako dříve splní výše uvedený krok kombinace příkazů `annotate` a "
"`download`:"

#. type: Fenced code block (bash)
#: site/content/en/tutorial.md
#, no-wrap
msgid ""
"reuse addheader --copyright=\"Jane Doe <jane@example.com>\" --license=\"CC0-1.0\" .gitignore\n"
"reuse annotate --copyright=\"Jane Doe <jane@example.com>\" --license=\"CC0-1.0\" .gitignore\n"
"\n"
"reuse download --all\n"
msgstr ""
"reuse addheader --copyright=\"Jane Doe <jane@example.com>\" --license=\"CC0-1.0\" .gitignore\n"
"reuse annotate --copyright=\"Jane Doe <jane@example.com>\" --license=\"CC0-1.0\" .gitignore\n"
"\n"
"reuse download --all\n"

Expand Down
18 changes: 9 additions & 9 deletions site/po/de.po
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2392,22 +2392,22 @@ msgstr ""
#. type: Plain text
#: site/content/en/tutorial.md
msgid ""
"The `reuse addheader` command helps with adding licensing and copyright "
"The `reuse annotate` command helps with adding licensing and copyright "
"information to your files. For the task above, the following command would "
"do the job:"
msgstr ""

#. type: Fenced code block (bash)
#: site/content/en/tutorial.md
#, no-wrap
msgid "reuse addheader --copyright=\"Jane Doe <jane@example.com>\" --license=\"GPL-3.0-or-later\" src/main.c Makefile README.md\n"
msgid "reuse annotate --copyright=\"Jane Doe <jane@example.com>\" --license=\"GPL-3.0-or-later\" src/main.c Makefile README.md\n"
msgstr ""

#. type: Plain text
#: site/content/en/tutorial.md
msgid ""
"Please see the [tool's documentation about addheader](https://reuse."
"readthedocs.io/en/stable/usage.html#addheader) for more options like "
"Please see the [tool's documentation about annotate](https://reuse."
"readthedocs.io/en/stable/usage.html#annotate) for more options like "
"comment styles and templates"
msgstr ""

Expand Down Expand Up @@ -2446,14 +2446,14 @@ msgstr ""
#: site/content/en/tutorial.md
msgid ""
"If it does not, or if you would like to enforce this, add the `--force-dot-"
"license` argument to the addheader command. So the command for the above "
"license` argument to the annotate command. So the command for the above "
"task may look like this:"
msgstr ""

#. type: Fenced code block (bash)
#: site/content/en/tutorial.md
#, no-wrap
msgid "reuse addheader --copyright=\"Jane Doe <jane@example.com>\" --license=\"GPL-3.0-or-later\" --force-dot-license img/cat.jpg img/dog.jpg\n"
msgid "reuse annotate --copyright=\"Jane Doe <jane@example.com>\" --license=\"GPL-3.0-or-later\" --force-dot-license img/cat.jpg img/dog.jpg\n"
msgstr ""

#. type: Title ###
Expand Down Expand Up @@ -2496,7 +2496,7 @@ msgstr ""
#: site/content/en/tutorial.md
msgid ""
"The tool as of now does not provide a way to replace existing REUSE-"
"compliant copyright and licensing information. A run of the `addheader` "
"compliant copyright and licensing information. A run of the `annotate` "
"command would not replace but extend the `.license` files with two "
"additional lines stating the copyright of Max Mehl and the CC-BY-4.0 "
"license. So you would have to update these manually."
Expand Down Expand Up @@ -2577,15 +2577,15 @@ msgstr ""
#. type: Plain text
#: site/content/en/tutorial.md
msgid ""
"As before, a combination of the `addheader` and `download` commands will "
"As before, a combination of the `annotate` and `download` commands will "
"fulfil the above step:"
msgstr ""

#. type: Fenced code block (bash)
#: site/content/en/tutorial.md
#, no-wrap
msgid ""
"reuse addheader --copyright=\"Jane Doe <jane@example.com>\" --license=\"CC0-1.0\" .gitignore\n"
"reuse annotate --copyright=\"Jane Doe <jane@example.com>\" --license=\"CC0-1.0\" .gitignore\n"
"\n"
"reuse download --all\n"
msgstr ""
Expand Down
18 changes: 9 additions & 9 deletions site/po/el.po
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2028,22 +2028,22 @@ msgstr ""
#. type: Plain text
#: site/content/en/tutorial.md
msgid ""
"The `reuse addheader` command helps with adding licensing and copyright "
"The `reuse annotate` command helps with adding licensing and copyright "
"information to your files. For the task above, the following command would "
"do the job:"
msgstr ""

#. type: Fenced code block (bash)
#: site/content/en/tutorial.md
#, no-wrap
msgid "reuse addheader --copyright=\"Jane Doe <jane@example.com>\" --license=\"GPL-3.0-or-later\" src/main.c Makefile README.md\n"
msgid "reuse annotate --copyright=\"Jane Doe <jane@example.com>\" --license=\"GPL-3.0-or-later\" src/main.c Makefile README.md\n"
msgstr ""

#. type: Plain text
#: site/content/en/tutorial.md
msgid ""
"Please see the [tool's documentation about addheader](https://reuse."
"readthedocs.io/en/stable/usage.html#addheader) for more options like "
"Please see the [tool's documentation about annotate](https://reuse."
"readthedocs.io/en/stable/usage.html#annotate) for more options like "
"comment styles and templates"
msgstr ""

Expand Down Expand Up @@ -2082,14 +2082,14 @@ msgstr ""
#: site/content/en/tutorial.md
msgid ""
"If it does not, or if you would like to enforce this, add the `--force-dot-"
"license` argument to the addheader command. So the command for the above "
"license` argument to the annotate command. So the command for the above "
"task may look like this:"
msgstr ""

#. type: Fenced code block (bash)
#: site/content/en/tutorial.md
#, no-wrap
msgid "reuse addheader --copyright=\"Jane Doe <jane@example.com>\" --license=\"GPL-3.0-or-later\" --force-dot-license img/cat.jpg img/dog.jpg\n"
msgid "reuse annotate --copyright=\"Jane Doe <jane@example.com>\" --license=\"GPL-3.0-or-later\" --force-dot-license img/cat.jpg img/dog.jpg\n"
msgstr ""

#. type: Title ###
Expand Down Expand Up @@ -2132,7 +2132,7 @@ msgstr ""
#: site/content/en/tutorial.md
msgid ""
"The tool as of now does not provide a way to replace existing REUSE-"
"compliant copyright and licensing information. A run of the `addheader` "
"compliant copyright and licensing information. A run of the `annotate` "
"command would not replace but extend the `.license` files with two "
"additional lines stating the copyright of Max Mehl and the CC-BY-4.0 "
"license. So you would have to update these manually."
Expand Down Expand Up @@ -2213,15 +2213,15 @@ msgstr ""
#. type: Plain text
#: site/content/en/tutorial.md
msgid ""
"As before, a combination of the `addheader` and `download` commands will "
"As before, a combination of the `annotate` and `download` commands will "
"fulfil the above step:"
msgstr ""

#. type: Fenced code block (bash)
#: site/content/en/tutorial.md
#, no-wrap
msgid ""
"reuse addheader --copyright=\"Jane Doe <jane@example.com>\" --license=\"CC0-1.0\" .gitignore\n"
"reuse annotate --copyright=\"Jane Doe <jane@example.com>\" --license=\"CC0-1.0\" .gitignore\n"
"\n"
"reuse download --all\n"
msgstr ""
Expand Down
24 changes: 12 additions & 12 deletions site/po/eo.po
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2075,22 +2075,22 @@ msgstr ""
#. type: Plain text
#: site/content/en/tutorial.md
msgid ""
"The `reuse addheader` command helps with adding licensing and copyright "
"The `reuse annotate` command helps with adding licensing and copyright "
"information to your files. For the task above, the following command would "
"do the job:"
msgstr ""

#. type: Fenced code block (bash)
#: site/content/en/tutorial.md
#, no-wrap
msgid "reuse addheader --copyright=\"Jane Doe <jane@example.com>\" --license=\"GPL-3.0-or-later\" src/main.c Makefile README.md\n"
msgstr "reuse addheader --copyright=\"Johanino Umo <johanino@example.com>\" --license=\"GPL-3.0-or-later\" fonto/ĉefprogramo.c Makefile README.md\n"
msgid "reuse annotate --copyright=\"Jane Doe <jane@example.com>\" --license=\"GPL-3.0-or-later\" src/main.c Makefile README.md\n"
msgstr "reuse annotate --copyright=\"Johanino Umo <johanino@example.com>\" --license=\"GPL-3.0-or-later\" fonto/ĉefprogramo.c Makefile README.md\n"

#. type: Plain text
#: site/content/en/tutorial.md
msgid ""
"Please see the [tool's documentation about addheader](https://reuse."
"readthedocs.io/en/stable/usage.html#addheader) for more options like "
"Please see the [tool's documentation about annotate](https://reuse."
"readthedocs.io/en/stable/usage.html#annotate) for more options like "
"comment styles and templates"
msgstr ""

Expand Down Expand Up @@ -2132,16 +2132,16 @@ msgstr ""
#: site/content/en/tutorial.md
msgid ""
"If it does not, or if you would like to enforce this, add the `--force-dot-"
"license` argument to the addheader command. So the command for the above "
"license` argument to the annotate command. So the command for the above "
"task may look like this:"
msgstr ""

#. type: Fenced code block (bash)
#: site/content/en/tutorial.md
#, fuzzy, no-wrap
#| msgid "reuse addheader --copyright=\"Jane Doe <jane@example.com>\" --license=\"GPL-3.0-or-later\" --explicit-license img/cat.jpg img/dog.jpg\n"
msgid "reuse addheader --copyright=\"Jane Doe <jane@example.com>\" --license=\"GPL-3.0-or-later\" --force-dot-license img/cat.jpg img/dog.jpg\n"
msgstr "reuse addheader --copyright=\"Johanino Umo <johanino@example.com>\" --license=\"GPL-3.0-or-later\" --explicit-license bildo/kato.jpg bildo/hundo.jpg\n"
#| msgid "reuse annotate --copyright=\"Jane Doe <jane@example.com>\" --license=\"GPL-3.0-or-later\" --explicit-license img/cat.jpg img/dog.jpg\n"
msgid "reuse annotate --copyright=\"Jane Doe <jane@example.com>\" --license=\"GPL-3.0-or-later\" --force-dot-license img/cat.jpg img/dog.jpg\n"
msgstr "reuse annotate --copyright=\"Johanino Umo <johanino@example.com>\" --license=\"GPL-3.0-or-later\" --explicit-license bildo/kato.jpg bildo/hundo.jpg\n"

#. type: Title ###
#: site/content/en/tutorial.md
Expand Down Expand Up @@ -2187,7 +2187,7 @@ msgstr ""
#: site/content/en/tutorial.md
msgid ""
"The tool as of now does not provide a way to replace existing REUSE-"
"compliant copyright and licensing information. A run of the `addheader` "
"compliant copyright and licensing information. A run of the `annotate` "
"command would not replace but extend the `.license` files with two "
"additional lines stating the copyright of Max Mehl and the CC-BY-4.0 "
"license. So you would have to update these manually."
Expand Down Expand Up @@ -2268,15 +2268,15 @@ msgstr ""
#. type: Plain text
#: site/content/en/tutorial.md
msgid ""
"As before, a combination of the `addheader` and `download` commands will "
"As before, a combination of the `annotate` and `download` commands will "
"fulfil the above step:"
msgstr ""

#. type: Fenced code block (bash)
#: site/content/en/tutorial.md
#, no-wrap
msgid ""
"reuse addheader --copyright=\"Jane Doe <jane@example.com>\" --license=\"CC0-1.0\" .gitignore\n"
"reuse annotate --copyright=\"Jane Doe <jane@example.com>\" --license=\"CC0-1.0\" .gitignore\n"
"\n"
"reuse download --all\n"
msgstr ""
Expand Down
Loading