Skip to content

Update README.md #62

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jun 11, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 32 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,32 +21,38 @@ Many home buyers use a calculator to determine their monthly house payment, but

## **File Structure**
```
Home-Choice-Pro/
├── main.py # Entry point of the application
├── requirements.txt # List of project dependencies
├── README.md # Project overview and documentation
├── LICENSE # License information
├── app/ # Main application package
│ ├── __init__.py
│ ├── main_window.py # Main window class
│ ├── controllers/ # Controllers for handling logic & analytics
│ ├── models/ # Data models (for analytics and logic classes)
│ └── views/ # UI files and components
│ ├── __init__.py
│ ├── main_window.ui # UI file created with Qt Designer
│ └── other_ui.ui # Other UI files
├── tests/ # Unit tests
│ ├── __init__.py
│ ├── test_main.py
│ └── other_tests.py
└── resources/ # Resources like images, icons, etc.
├── images/
├── icons/
└── styles/
├── CONTRIBUTING.md
├── home-choice-pro
│   ├── docs
│   │   └── user_guide.md
│   ├── images
│   │   └── Gemini_Generated_Image_njly4xnjly4xnjly.jpeg
│   ├── main.py
│   ├── models
│   │   ├── affordability_calculator.py
│   │   └── __init__.py
│   ├── resources
│   │   ├── main_window.ui
│   │   ├── pop_up_error_window.ui
│   │   └── resources.qrc
│   ├── resources_rc.py
│   ├── tests
│   │   ├── __init__.py
│   │   ├── test_models
│   │   │   ├── __init__.py
│   │   │   └── test_affordability_calculator.py
│   │   └── test_views
│   │   ├── __init__.py
│   │   └── test_main_window.py
│   └── views
│   ├── __init__.py
│   ├── main_window.py
│   ├── main_window_ui.py
│   ├── pop_up_error_window.py
│   └── pop_up_error_window_ui.py
├── LICENSE
├── README.md
└── requirements.txt
```

## **Contributors:**
Expand Down