From ca8314ed39d37e6aa61b55d16533f24eceaeeb4b Mon Sep 17 00:00:00 2001 From: "Alex A. Naanou" Date: Sun, 10 Mar 2024 12:10:39 +0300 Subject: [PATCH] docs... Signed-off-by: Alex A. Naanou --- Archive/README.md | 95 ++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 93 insertions(+), 2 deletions(-) diff --git a/Archive/README.md b/Archive/README.md index 654e9bcd..4bd01427 100644 --- a/Archive/README.md +++ b/Archive/README.md @@ -7,7 +7,98 @@ $ cp -R ./media PATH_TO_ARCHIVE_DRIVE ``` The scripts are stored with the archive for generational compatibility, -both building and documenting the structure the archive was created -with. +both building and documenting the structure the archive was created with. +## Scripts + +``` +media +├── img +│   └── my +│   └── work +│   ├── sync-flash.sh +│   ├── process-archive.sh +│   ├── compress-archive.sh +│   └── update-exif.sh +└── tree.sh +``` + +### `sync-archive.sh` + +Ingest media into the archive and prepare it for further steps in the +workflow + +This script can be run interactively: +```shell +$ ./sync-archive.sh +``` + +This will: +- Create the necessary directory structure + (see: [Archive directory structure](arcive-direcotry-structure)) +- Copy and verify the contents of 1 or more external media + to the archive directory +- Prepare the archive for further work via `process-archive.sh` +- Compress the archive via `compress-archive.sh` + + +### `process-archive.sh` + +```shell +$ ./process-archive.sh [FLAGS] PATH +``` + + +### `compress-archive.sh` + +```shell +$ ./compress-archive.sh [FLAGS] PATH +``` + + +### `update-exif.sh` + +```shell +$ ./update-exif.sh [FLAGS] PATH +``` + + +### `tree.sh` + + + +## Archive directory structure + + +``` +media +├── img +│   ├── my +│   │ └── work +│   │ ├── - 20240310 - shoot directory (multi flash card) +│   │ │ ├── 20240310.001 +│   │ │ │ ├── ... +│   │ │ │ └── preview (RAW) +│   │ │ ├── 20240310.002 +│   │ │ │ ├── ... +│   │ │ │ └── preview (RAW) +│   │ │ ├── ... +│   │ │ └── preview (RAW) +│   │ ├── - 20240310.001 - shoot directory (single flash card) +│   │ │ ├── ... +│   │ │ └── preview (RAW) +│   │ ├── 20240310 - shoot directory (fully sorted) +│   │ │ └── ... +│   │ ├── ... +│   │ ├── sync-flash.sh +│   │ ├── process-archive.sh +│   │ ├── compress-archive.sh +│   │ └── update-exif.sh +│   └── others +│   └── ... +├── video +│   └── ... +├── ... +└── tree.sh +```