Skip to content

Commit

Permalink
Update readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Daethyra authored Jun 8, 2023
1 parent a9ace58 commit 2ff7d9a
Showing 1 changed file with 13 additions and 36 deletions.
49 changes: 13 additions & 36 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,45 +1,22 @@
# Simple Image Converter
# PNG/JPG Converter | Multi-Extension Converter
- Image type conversion for technical users
- File type conversion for technical users

This project is a simple Python script to convert .png images to .jpg and vice versa.

## Installation
Follow the steps below to use this script:
## This repository has multiple branches for different iterations of the same project.

1. Clone the repository:
```
git clone https://github.com/<yourusername>/simple-image-converter.git
```
2. Navigate to the project directory:
```
cd simple-image-converter
```
3. (Optional) Set up a virtual environment:
```
python3 -m venv venv
source venv/bin/activate
```
4. Install the required packages:
```
pip install -r requirements.txt
```
5. Run the script:
```
python main.py
```
### The [main branch](https://github.com/Daethyra/Image-Converter/tree/main) is a reflection of the work in progress.

## Usage
When you run `main.py`, you'll be presented with a menu of options for image conversion. Follow the prompts to convert your images. You can convert all .png images to .jpg (and vice versa) in the current working directory or a specified directory, or convert a specific image file.
##### Versions [4-Multi-Extension-Converter](https://github.com/Daethyra/Image-Converter/tree/v4-Multi-Extension-Converter) and [4.2-MEC-Docker](https://github.com/Daethyra/Image-Converter/tree/v4.2-MEC-Docker) have multi-extension conversion functionality and have not been thoroughly tested, though I've not experienced problems.

1. Convert all PNG images in the current working directory to JPG.

2. Convert all JPG images in the current working directory to PNG.
------

3. Convert a specific PNG to JPG.
## Simple Image Converter - [main branch](https://github.com/Daethyra/Image-Converter/tree/main), [v1.1](https://github.com/Daethyra/Image-Converter/edit/v1.1/readme.md)

4. Convert a specific JPG to PNG.
5. Convert all PNG images in a specified directory to JPG.
This project is a simple Python script to convert .png images to .jpg and vice versa.
- Supports [PNG, PDF, JPG]

6. Convert all JPG images in a specified directory to PNG.
-----

Input the number of your choice and hit enter. Happy transition!
## Multi-Extension Converter - [4-Multi-Extension-Converter](https://github.com/Daethyra/Image-Converter/tree/v4-Multi-Extension-Converter), [4.2-MEC-Docker](https://github.com/Daethyra/Image-Converter/tree/v4.2-MEC-Docker)
- Supports [PDF, JPG, JPEG, TXT, ODT, HTML, PNG, BMP]

0 comments on commit 2ff7d9a

Please sign in to comment.