Merge pull request #1 from louispawaon/v2

SnapShift

README.md

@@ -1,29 +1,37 @@
-# **heic-to-jpg**
-converting heic files using the internet is cumbersome so i made this not-so-intuitive way of converting things
+# **SnapShift**
+Previously *heic-to-jpg*, converting heic files using the internet is cumbersome and so i made this *now intuitive* way of converting `.heic` files to multiple image formats.
 
 # **Installation**
-To run this script, you will need to install the required libraries listed in the `requirements.txt` file. You can do this using pip by running the following command in your terminal:
-
-```
-pip install -r requirements.txt  # for Windows
-```
-
-Alternatively, you can manually install the required libraries by running the following command for each library:
-
-```
-pip install <library-name>
-```
-
-# **Usage**
-To use the script, run the following command in your terminal:
-
-```
-python3 converter.py
-```
-Choose the folder with your HEIC file/s, and it will automatically place the converted HEIC files to the same path destination of your HEIC file/s folder.
+1. Download the `SnapShift.exe` file
+2. Choose your Target Folder with the .heic images
+3. Choose your Destination Folder for the converted images
+4. Choose what image type you want your .heic file to be converted
+5. Convert and wait for it to be finished.
 
 # **Contributing**
+
 Contributions to this project are welcome! To contribute, please fork this repository, make your changes, and submit a pull request. Before submitting a pull request, please make sure that your changes are well-tested and adhere to the PEP 8 style guide.
 
+To run this script, you will need to install the required libraries listed in the `requirements.txt` file. 
+
+1. Clone the repository 
+    ```
+    git clone https://github.com/louispawaon/snapshift.git
+    ```
+2. Create a virtual environment
+    ```
+    cd SnapShift
+    python3 -m venv venv
+    ```
+3. Install `requirements.txt`
+   ```
+   pip install -r requirements.txt
+   ```
+4. Run the script
+   ```
+   cd src
+   python3 converter.py
+   ```
+
 # **Issues**
-If you encounter any issues while using this script, please report them by creating a new [issue](https://github.com/louispawaon/heic-to-jpg/issues) in the issue tracker. When reporting an issue, please include a detailed description of the problem, along with any relevant error messages and steps to reproduce the issue.
+If you encounter any issues while using this script, please report them by creating a new [issue](https://github.com/louispawaon/snapshift/issues) in the issue tracker. When reporting an issue, please include a detailed description of the problem, along with any relevant error messages and steps to reproduce the issue.