Skip to content

Commit

Permalink
Create README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
rekterakathom authored Aug 6, 2024
1 parent a98c625 commit db7bd8f
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# 🖼 BatImgCon (Batch Image Converter)
A simple to use Python tool to batch convert images between formats, including AVIF.

## 💡 Features
- Image format support using *pillow*
- AVIF support using *pillow_avif_plugin*
- Asynchronous operation
- Beautiful and usable CLI using *typer* and *rich*
- QOL features such as optional reduced process priority for background processing

![image](https://github.com/user-attachments/assets/fe6907b4-d239-43af-9173-3afac7731ade)

# 🔨 Installation
1. Download the repository
2. Create a virtual environment ``python -m venv /path/to/environment``
3. Activate the environment using the activation script for your OS in: ``/path/to/environment/Scripts/``
4. Install the requirements: ``pip install -r /path/to/requirements.txt``
5. Run ``BatImgCon.py --help`` for instructions on how to work the program.
6. Congratulations, you have successfully installed and operated BatImgCon 🎉

# 💬 Contributing & Issue reports
All collaborative work, such as issue reports and pull requests, should be submitted to this GitHub repository in their provided sections.

# 📜 Licensing
Licensed with the MIT License. By using this software, you agree to the terms and conditions of the license.

0 comments on commit db7bd8f

Please sign in to comment.