Skip to content
This repository has been archived by the owner on Feb 15, 2023. It is now read-only.

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
natecraddock committed Dec 8, 2018
2 parents a5eb6aa + 4f0629b commit 6fbbe2f
Showing 1 changed file with 22 additions and 14 deletions.
36 changes: 22 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# Page Zipper
[Download v1.1]()
[Download v1.1](https://github.com/natecraddock/page-zipper/releases/download/v1.1/Page.Zipper.v1.1.exe)

Page Zipper is a tool to aid in the document capture process. It is designed to merge (zip) right and left captured pages of books.

Page Zipper takes input from two folders, for the left and right pages, merges the pages like a zipper (right, left, right, left, right, left), and saves the images in a specified output directory.
Expand All @@ -11,31 +12,38 @@ At the [Shelby County Museum & Archive](https://shelbycountymuseum.com) we had b
We decided that capturing the right and left pages separately would be the easiest way to proceed. Page Zipper was created to merge the left and right pages together.

# How To Use Page Zipper
# Inputs
Page zipper takes two folders for input, one for left pages, and one for right pages. It assumes that the right page (cover) will go first.
To choose a folder, click *Browse*. Navigate and select the directory containing the images to zip. Repeat for the other side.
## Inputs
The `Input` tab contains two image thumbnail viewers. Page zipper takes two folders for input, one for left pages, and one for right pages. It assumes that the right page (cover) will go first.
To choose a folder, click `Browse`. Navigate and select the directory containing the images to zip. Repeat for the other side.

Select pages by clicking on the thumbnails. Select pages and click group to group a set of pages together. Grouped pages will maintain the same order after the merge.
Click ungroup after selecting a group to ungroup a set of pages.
Select pages by clicking on the thumbnails. Select pages and click `Group` to group a set of pages together. Grouped pages will maintain the same order after the merge.
Click `Ungroup` after selecting a group to ungroup a set of pages.

In the output tab a preview of the output is shown in order.
Specify an output directory, and a filename prefix. Click save to save the files.
## Outputs
In the `Output` tab a preview of the output is shown in order.
Specify an output directory by clicking `Browse`. A filename prefix can also be set. Click `Save` to save the files to the specified output directory.

In the utilities tab there is a renamer. It allows a numerical rename of files in a folder.
## Utilities
In the `Utilities` tab there is a renamer. It allows a numerical rename of files in a folder.
The renamer also supports a filename prefix.
Clicking `Rename` will create a new folder in the same location as the chosen folder. Its name will be `<folder_name>_renamed`

The help tab has a link to this readme, a support email, and a link to report issues.
## Help
The `Help` tab has a link to this readme, a support email, and a link to report issues.

# Building
## Dependencies
pyinstaller
pip install pyinstaller

To build a windows executable
pyinstaller -F -n "Page Zipper v1.1" --add-data="icon.ico;." --icon="icon.ico" __main__.py
`pip install pyinstaller`

To build a Windows executable

`pyinstaller -F -n "Page Zipper v1.1" --add-data="icon.ico;." --icon="icon.ico" __main__.py`

The executable file will be found in the dist directory

for rebuilds
pyinstaller "Page Zipper v1.1.spec"

`pyinstaller "Page Zipper v1.1.spec"`

0 comments on commit 6fbbe2f

Please sign in to comment.