Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
 - This is actual markdown! so use it :)
  • Loading branch information
Alan Formy-Duval committed Sep 29, 2021
1 parent 0d924e6 commit 7b2fdfa
Showing 1 changed file with 31 additions and 17 deletions.
48 changes: 31 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,36 @@
## README ##
prepimg - a script to prepare images (screenshots) for inclusion in articles to be submitted
to opensource.com for publication. opensource.com (OSDC) requires a maximum width for images
to be 600 pixels. This script does the following:
- reduces width to meet OSDC 600 pixel limit
- adds a 1 pixel border of specified color
- places finished images into a "Ready" directory
**prepimg.sh** - a script to prepare images (screenshots) for inclusion in articles to be submitted
to opensource.com for publication. The opensource.com (OSDC) platform requires a maximum width for images
to be 600 pixels.

This script does the following:
+ reduces width to meet OSDC 600 pixel width limit
+ adds a 1 pixel border of specified color
+ places finished images into a "Ready" directory

___

## PEOPLE ##
AUTHOR='Alan Formy-Duval'
Thanks to the following people for contributing code and structure.
Seth Kenlon
**Author**

+ Alan Formy-Duval

**Thanks to the following contributors**

+ Seth Kenlon

___
## USAGE ##
prepimg.sh -h / --help
--verbose, -v Be verbose
--directory, -d Screenshot directory (default: <your home directory>/Pictures/Screenshots)
The directory where images to be processed are located can be specified by this option.
--ready, -r Ready directory (default: <your home directory>/Pictures/Screenshots/Ready)
The directory where processed images are saved can be specified by this option.
--border, -b Border color (default: black)
The border color can be specified with this option.
**prepimg.sh** [OPTION] [ARGUMENT]

- --help, -h Display this help facility
- --verbose, -v Be verbose
- --directory, -d Screenshot directory
+ (default: <your home directory>/Pictures/Screenshots)
+ The directory where images to be processed are located can be specified by this option.
- --ready, -r Ready directory
+ (default: <your home directory>/Pictures/Screenshots/Ready)
+ The directory where processed images are saved can be specified by this option.
- --border, -b Border color
+ (default: black)
+ The border color can be specified with this option.

0 comments on commit 7b2fdfa

Please sign in to comment.