diff --git a/README.md b/README.md index 07e3c92..361565b 100644 --- a/README.md +++ b/README.md @@ -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]**". +
+
+Example: python Python-Mini-ImageProcessory.py --blur 2 --contrast 3 --brightness 2 example_image.jpg +
+
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.