-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
EvanRaeder
committed
Jul 29, 2024
1 parent
3e98b58
commit 4ea51ff
Showing
1 changed file
with
39 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
# Image File Encoder/Decoder | ||
|
||
## Description | ||
|
||
This project is aimed at managing and organizing image files. It provides a user-friendly interface to browse, search, and categorize images efficiently. Additionally, it includes functionality for encoding and decoding image files using buffer writing to optimize memory usage. | ||
|
||
## Features | ||
|
||
- Bulk operations for managing multiple images at once | ||
- Encode files to .PNG | ||
- Decode .PNG files back to the original format | ||
- Command-line interface | ||
- Simple UI for user interaction | ||
|
||
## PreBuilt | ||
Binary releases for windows-latest can be found [here](https://github.com/EvanRaeder/image_files/releases). | ||
|
||
## Installation | ||
|
||
1. Clone the repository: `git clone https://github.com/EvanRaeder/image_files` | ||
2. Navigate to the project directory: `cd repo` | ||
3. Install dependencies: `cargo build --release` | ||
|
||
## Usage | ||
|
||
### Command-Line Interface | ||
|
||
To use the command-line interface, run the executable with the appropriate flags: | ||
|
||
```sh | ||
image_files.exe -e <filename> <output&optional> # Encode the specified file | ||
image_files.exe -d <filename> <output&optional> # Decode the specified file | ||
``` | ||
|
||
### Application Interface | ||
|
||
1. Double-click run image_files.exe | ||
2. Follow the prompts to either (e)ncode or (d)ecode a file and drag and drop or copy in the files location. | ||
3. Specify a new working directory for the app if the files should be saved elsewhere. |