ChatDev/WareHouse/MoneyCtrl_THUNLP_20230825093546/manual.md
2023-09-04 19:24:28 +08:00

3.7 KiB

Personal Budget App User Manual

Introduction

The Personal Budget App is a basic application developed in Python that allows users to track their income and expenses and generate reports. This user manual provides a detailed guide on how to install the app and use its main functions.

Table of Contents

  1. Installation
  2. Usage
    • Adding Income
    • Adding Expenses
    • Generating Reports
  3. Dependencies
  4. Conclusion

1. Installation

To install the Personal Budget App, follow these steps:

  1. Make sure you have Python installed on your system. You can download Python from the official website: https://www.python.org/downloads/

  2. Download the source code for the app from the repository: https://github.com/your-repository

  3. Extract the downloaded ZIP file to a directory of your choice.

  4. Open a terminal or command prompt and navigate to the directory where you extracted the source code.

  5. Install the required dependencies by running the following command:

    pip install -r requirements.txt
    
  6. Once the dependencies are installed, you are ready to use the Personal Budget App.

2. Usage

The Personal Budget App provides the following main functions:

Adding Income

To add income to your budget, follow these steps:

  1. Launch the app by running the following command in the terminal or command prompt:

    python main.py
    
  2. The app window will open. You will see two input fields labeled "Income" and "Expenses".

  3. Enter the amount of income in the "Income" input field.

  4. Enter a description for the income in the adjacent input field.

  5. Click the "Add Income" button to add the income to your budget.

  6. A success message will be displayed, indicating that the income has been added successfully.

Adding Expenses

To add expenses to your budget, follow these steps:

  1. Launch the app by running the following command in the terminal or command prompt:

    python main.py
    
  2. The app window will open. You will see two input fields labeled "Income" and "Expenses".

  3. Enter the amount of expenses in the "Expenses" input field.

  4. Enter a description for the expenses in the adjacent input field.

  5. Click the "Add Expenses" button to add the expenses to your budget.

  6. A success message will be displayed, indicating that the expenses have been added successfully.

Generating Reports

To generate a report of your budget, follow these steps:

  1. Launch the app by running the following command in the terminal or command prompt:

    python main.py
    
  2. The app window will open. You will see two input fields labeled "Income" and "Expenses".

  3. Enter the income and expenses as described in the previous sections.

  4. Click the "Generate Report" button to generate a report of your budget.

  5. The report will be displayed in the text area below the buttons, showing the total income, total expenses, and net income.

3. Dependencies

The Personal Budget App has the following dependencies:

  • tkinter: This library is used for creating the graphical user interface (GUI) of the app.
  • numpy: This library is used for performing numerical calculations in the app.
  • pandas: This library is used for data manipulation and analysis in the app.

These dependencies are automatically installed when you run the command pip install -r requirements.txt during the installation process.

4. Conclusion

Congratulations! You have successfully installed and learned how to use the Personal Budget App. You can now track your income and expenses, generate reports, and manage your budget effectively. If you have any further questions or need assistance, please refer to the documentation or contact our support team.