Add initial README.md for Connections application - #2
Conversation
Added detailed documentation for the Connections application, including features, contact fields, project structure, requirements, and future ideas.
There was a problem hiding this comment.
Pull request overview
Adds an initial README.md documenting the Connections desktop contacts application (PyQt5 + SQLite), intended to help users understand features, data storage, and how to run the app.
Changes:
- Introduces a comprehensive README covering features, UI screens, import flow, database behavior, and security notes.
- Documents expected project layout and basic install/run instructions.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| # Connections | ||
|
|
||
| A desktop contact management application written in Python using **PyQt5** and **SQLite**. | ||
|
|
||
| Connections allows you to organize contacts into multiple independent tables (groups), search across them, combine multiple datasets, and import contacts directly from Google Contacts CSV exports. |
| ├── main.py | ||
| ├── backend.py | ||
| ├── global-network.ico | ||
| └── table.db |
| ### Windows | ||
|
|
||
| ``` | ||
| %LOCALAPPDATA%/connections-app/ |
| Install dependencies: | ||
|
|
||
| ```bash | ||
| pip install PyQt5 |
| ## Running | ||
|
|
||
| ```bash | ||
| python main.py |
|
@Benedek553 ValueError: Received icon image '/Users/runner/work/Connections/Connections/global-network.ico' which exists but is not in the correct format. On this platform, only ('icns',) images may be used as icons. If Pillow is installed, automatic conversion will be attempted. Please install Pillow or convert your 'ico' file to one of ('icns',) and try again. Add an icns file to the project so the make pipeline for Mac works. |
|
Added The existing |
|
@Benedek553 Add a GPL V3 License and address the issues Copilot flagged above. |
|
@Benedek553 Apply the other fixes that can no longer be auto applied due to the latest commits eg. making sure the file structure is correct etc. |
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Added support for an additional icon file in the PyInstaller build.
|
@Zacharymk1213 The Copilot suggested fixes now applied. |
Added detailed documentation for the Connections application, including features, contact fields, project structure, requirements, and future ideas.
Important
Add a proper project license (e.g. LICENSE file and headers) before merging.