Skip to content

Commit d1fba5b

Browse files
author
Princee
committed
docs: add comprehensive documentation for Spell-Sense
1 parent 39f0fa6 commit d1fba5b

1 file changed

Lines changed: 49 additions & 0 deletions

File tree

Spell-Sense/README.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# Spell-Sense: Advanced Spell Checker
2+
3+
Spell-Sense is a professional, modular Python application that provides real-time spelling suggestions. Built with `Tkinter` and `TextBlob`, it improves upon basic implementations by adding robust error handling and a clean, user-friendly interface.
4+
5+
## Features
6+
- Smart Validation: Detects empty inputs and prevents unnecessary processing.
7+
- Color-Coded Feedback: Uses visual cues (Green for success, Blue for suggestions, Red for errors).
8+
- Modular Design: Separation of concerns between UI logic and processing logic.
9+
- Keyboard Friendly: Press `Enter` to check spelling instantly without clicking.
10+
- Auto-Focus: The cursor starts in the input box for immediate typing.
11+
12+
## Project Structure
13+
/Spell-Sense/
14+
├── main.py # Entry point and UI (Tkinter)
15+
├── logic.py # Core NLP logic (TextBlob)
16+
├── requirements.txt # Dependency list
17+
└── README.md # Documentation
18+
19+
🚀 Installation & Setup
20+
Prerequisites
21+
Python 3.6 or higher
22+
23+
Setup
24+
Navigate to your project directory:
25+
26+
Bash
27+
cd Spell-Sense
28+
Install the required dependencies:
29+
30+
Bash
31+
pip install -r requirements.txt
32+
🛠️ Usage
33+
Run the script from your terminal:
34+
35+
Bash
36+
python main.py
37+
Type a word into the input box.
38+
39+
Press Enter or click Check.
40+
41+
View the suggestion or success message below.
42+
43+
Click Reset to clear the fields.
44+
45+
📝 Credits
46+
This project was developed as an enhanced alternative to basic scripts in this repository. It focuses on modularity, error handling, and improved User Experience (UX).
47+
48+
License
49+
This project is open-source and intended for educational use.

0 commit comments

Comments
 (0)