Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
abullard1 authored Aug 9, 2023
1 parent 7e606df commit a346e4f
Showing 1 changed file with 11 additions and 7 deletions.
18 changes: 11 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,18 @@ contrast, blur, sharpen, dilate, erode, edge detection and mirror. Modified imag
This project was part of some of my university coursework.

## Usage
To use the program first mage sure that you have python installed. The easiest way to download python would be to download it from the Microsoft Store. The program was made
using Python 3.10. Lower versions have not been tested and might or might not work. Also make sure to have the python packages PIL (pillow) and tk (tkinter) installed.
To do this, simply open cmd.exe and type "pip install tk pillow". The necessary packages will then be downloaded and installed.
To use the program first mage sure that you have python installed. The easiest way to download python would be to download it from the Microsoft Store if you're using WindowsOS. The program was made
using Python 3.10. Lower versions have not been tested and may or may not work. Also make sure to have the python packages PIL (pillow) and tk (tkinter) installed.
To do this, simply open cmd.exe and type "**pip install tk pillow**". The necessary packages will then be downloaded and installed. Alternatively you can download the necessary packages using a package manager of your choice like Anaconda.
You can either run the program by using your command line or by running it using an IDE like Pycharm. To use the program via the command line (e.g. cmd.exe), navigate to the
folder where the "Python-Mini-ImageProcessory.py" script is located by typing "cd [Absolute Path to folder in which Python-Mini-ImageProcessory.py is located]".
After you've done that, type "python Python-Mini-ImageProcessory.py [Optional: --contrast 2 --blur 2 etc.] [Optional: Absolute Path to image you want to modify or name of image if it
is located in the same directory of the script].
Example 1: python Python-Mini-ImageProcessory.py --blur 2 --contrast 3 --brightness 2 example_image.jpg
folder where the "**Python-Mini-ImageProcessory.py**" script is located by typing "**cd [Absolute Path to folder in which Python-Mini-ImageProcessory.py is located]**".
After you've done that, type "**python Python-Mini-ImageProcessory.py [Optional: --contrast 2 --blur 2 etc.] [Optional: Absolute Path to image you want to modify or name of image if it
is located in the same directory of the script]**".
<br>
<br>
Example: python Python-Mini-ImageProcessory.py --blur 2 --contrast 3 --brightness 2 example_image.jpg
<br>
<br>
For a list of command line arguments use the argument --help.
If no image path or name is given, a file explorer window will open where you can select the image file to modify. After pressing enter, a GUI will open up where you can
see the changes made to the image via the command line arguments (if you input any) and make further changes, reset the changes, save the image or view all possible command line arguments.
Expand Down

0 comments on commit a346e4f

Please sign in to comment.