Skip to content

Commit 7eeaf05

Browse files
committed
Update README.md
1 parent 6ab302b commit 7eeaf05

1 file changed

Lines changed: 76 additions & 1 deletion

File tree

README.md

Lines changed: 76 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,76 @@
1-
# python-contacts-list
1+
2+
# 📇 Python Contacts List
3+
4+
A simple and lightweight desktop contact manager built with Python and Tkinter.
5+
This app allows you to create, view, edit, and delete contact information, stored locally as `.txt` files in a `contacts/` folder.
6+
7+
---
8+
9+
## ✨ Features
10+
11+
- 🔍 View all contacts in a scrollable list
12+
- ➕ Add new contact with name, phone, and email
13+
- ✏️ Edit existing contacts
14+
- 🗑️ Delete contacts
15+
- 🧾 Automatically stores each contact in a `.txt` file
16+
- 📁 Works offline — no database or internet required
17+
18+
---
19+
20+
## 📂 Folder Structure
21+
22+
```
23+
project-folder/
24+
├── main.py
25+
└── contacts/
26+
├── John_Doe.txt
27+
├── Jane_Smith.txt
28+
└── ...
29+
```
30+
31+
Each contact file contains:
32+
```
33+
Name: John Doe
34+
Phone: 123-456-7890
35+
Email: john@example.com
36+
```
37+
38+
---
39+
40+
## 🛠️ Requirements
41+
42+
Just make sure you have Python 3.x installed.
43+
44+
If Tkinter is not installed, run:
45+
46+
```bash
47+
pip install tk
48+
```
49+
50+
---
51+
52+
## ▶️ How to Run
53+
54+
1. Place `main.py` in your working folder.
55+
2. Create a `contacts/` folder in the same directory (if not already created automatically).
56+
3. Run the app:
57+
58+
```bash
59+
python main.py
60+
```
61+
62+
---
63+
64+
## 📸 Screenshot
65+
66+
Add a screenshot named `screenshot.png` to the root of your repo to display here.
67+
68+
```markdown
69+
![App Screenshot](screenshot.png)
70+
```
71+
72+
---
73+
74+
## 🙌 Author
75+
76+
Made with ❤️ by [Mostafa Baghi](https://github.com/mostafabaghi)

0 commit comments

Comments
 (0)