Skip to content

Commit b7273f0

Browse files
authoredJan 8, 2025
Update README.md
1 parent 63a9111 commit b7273f0

File tree

1 file changed

+23
-3
lines changed

1 file changed

+23
-3
lines changed
 

‎README.md

+23-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
# PyExeForge - Python to EXE Converter
22

33
## OVERVIEW
4-
PyExeForge is a GUI tool that converts Python scripts into standalone executable files.
4+
PyExeForge is a modern, user-friendly GUI tool designed to convert Python scripts into standalone executable files.
5+
Built with educators, developers, and students in mind, it simplifies the process of distributing Python applications.
56
It features a modern dark emerald theme, real-time progress tracking, and intuitive controls.
67

78
## PURPOSE
@@ -10,6 +11,13 @@ It features a modern dark emerald theme, real-time progress tracking, and intuit
1011
* Provide a user-friendly alternative to command-line tools
1112
* Support both educational and professional development needs
1213

14+
## KEY FEATURES
15+
* Simple, intuitive interface
16+
* Real-time conversion progress tracking
17+
* Dark emerald theme for reduced eye strain
18+
* Support for both single-file and directory-based executables
19+
* Options for console and window-based applications
20+
1321
## REQUIREMENTS
1422
* Python 3.7 or higher
1523
* Windows operating system
@@ -18,7 +26,7 @@ It features a modern dark emerald theme, real-time progress tracking, and intuit
1826

1927
## INSTALLATION
2028
1. Clone/download the repository
21-
2. Run: `python setup.py`
29+
2. Run: `python setup.py` to create the virtual environment and install dependencies
2230
3. Launch using: `launch_converter.bat`
2331

2432
## USAGE
@@ -31,13 +39,25 @@ It features a modern dark emerald theme, real-time progress tracking, and intuit
3139
5. Wait for completion
3240
6. Find your executable in the selected output directory
3341

34-
## USE CASE EXAMPLE
42+
## USE CASE EXAMPLES
43+
44+
### Developer Use Case
3545
**Scenario:** A developer creates an internal tool for data processing
3646
**Problem:** Team members don't have Python installed
3747
**Solution:** Using PyExeForge to:
3848
1. Convert the tool to an executable
3949
2. Distribute single file to team
4050
3. Enable immediate use without Python installation
4151

52+
### Educational Use Case
53+
**Scenario:** A teacher creates a Python-based educational game
54+
**Problem:** Students don't have Python installed
55+
**Solution:** Using PyExeForge to:
56+
1. Select their game script
57+
2. Choose an output location
58+
3. Select "Window Based" mode
59+
4. Click convert
60+
5. Distribute the resulting .exe file to students
61+
4262
## SUPPORT
4363
For issues or questions, please open an issue on GitHub.

0 commit comments

Comments
 (0)
Please sign in to comment.