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.

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

README - update writelto, attempts to fix #169 #196

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
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
4 changes: 1 addition & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,11 +108,9 @@ Whenever a tape is ejected, the script will export the tape’s index (as an XML
To write data onto a tape, run the following command:

```
writelto
writelto -t $tape_serial $source_directory
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sorry to nitpick, but I think maybe writing inputs as variables in the docs might confuse some people who aren't familiar with $ denoting a user changeable variable?

I never am sure of the most intuitive way to denote user inputs in docs, but maybe TAPE_SERIAL and SOURCE_DIRECTORY, or possibly [Tape Serial] [Source Directory]? (Although when I have used the latter format I often find myself having to explain that the [ ] are not part of the command. I wonder if there is any common precedent across amiaos repos?

```

When prompted, enter the tape serial and the source directory.

The script will run `gcp` to transfer the data to the LTO tape (`rsync` is used as a backup check for `gcp`).

To read back and create checksums for the contents of a tape, and write checksums to a file named with the tape serial and date, run the following command:
Expand Down