updated readme, readmes

Author: johnfkraus

.gitignore

@@ -4,7 +4,6 @@
 .idea
 dist
 node_modules
-package.json
 photos/srcset/
 photos/set1/
 photos/set2/

README-TEMPLATE.md

@@ -9,15 +9,20 @@ git config core.hooksPath .githooks
 
 ## Features:
 
-- There is a .gitignore file tailored to Python/HuggingFace projects.
+### .gitignore
 
-- The project root directory contains a `.githooks/` directory inside which there is a pre-commit script intended to prevent committing any file larger than a certain size, for example, 10MB. If your commit is blocked by the pre-commit script:
-  - Run `git reset [BIG_FILE_OR_DIRECTORY_NAME]`
-  - Add the oversized file or directory to the `.gitignore` file.
+- The project has a .gitignore file tailored to Python/HuggingFace projects.
 
 - To enable a `~/.gitignore_global` file for JetBrains (PyCharm, etc.) projects(or other projects), create the global gitignore file and configure git as follows:
 
 ```bash
 git config --global core.excludesfile ~/.gitignore_global
 ```
 
+### Precommit script prevents commits containing oversized files
+
+- The Github repository template's project root directory contains a `.githooks/` directory inside which there is a pre-commit script intended to prevent committing any file larger than a certain size.  GitHub recommends a maximum individual file size of 1MB, with a hard limit enforced at 100MB. Files exceeding 100MB will generally be blocked and require the use of Git Large File Storage (Git LFS) (at additional cost).  (Removing large files from a commit can be tedious.)
+- The pre-commit script has a default maximum size of 10MB which you can change.  (This is to prevent Github from choking on and blocking large files.)  If your commit is blocked by the pre-commit script:
+  - Run `git reset [BIG_FILE_OR_DIRECTORY_NAME]`
+  - Add the oversized file or directory to the `.gitignore` file.
+

package.json

@@ -2,7 +2,7 @@
   "name": "react-photo-album-lightbox",
   "description": "React Lightbox Photo Album",
   "version": "0.1.0",
-  "author": "John Kraus, based on work by Igor Danchenko",
+  "author": "John Kraus, based on a Github repo by Igor Danchenko",
   "license": "MIT",
   "private": true,
   "type": "module",

scripts/step00_create_srcsets.py

@@ -1,16 +1,14 @@
-# script for creating srcset image copies
+# script for creating srcset image copies for upload to CDN
 
 import step01_add_dimensions_to_original_image_names
 import step02_create_resized_image_copies_for_srcset
 import step03_copy_orig_image_rename_for_srcset
 import step04_cleanup
 
-start='photos/input/'  # dir must exist before running this code
-renamed='photos/work_in_process/'
-dest='photos/srcset/'
+start='photos/input/'  # this dir must exist before running this code; put the to-be-processed photos here
+renamed='photos/work_in_process/'  # temporary location for renamed version of original photo
+dest='photos/srcset/'  # final output of photo srcset for upload to CDN; there should be nine versions of each photo here
 archives = 'photos/archives/'
-# renamed='/Users/blauerbock/workspaces/react-photo-album-main/examples/react-lightbox-photo-album/photos/renamed/'
-# dest='/Users/blauerbock/workspaces/react-photo-album-main/examples/react-lightbox-photo-album/photos/dest/'
 
 if __name__ == "__main__":
     step01_add_dimensions_to_original_image_names.rename_images_add_dimensions(start, renamed)