docs: finalized readme file for first version

Author: nmb735

README.md

@@ -1,80 +1,83 @@
-# 📡 RFID-Reader-FX7500
-
-Contains the necessary scripts, files, and documentation to use the Zebra FX7500 RFID reader.
-
-## 📂 Directory Structure
-
-- **src/**: Contains the source code for the RFID reader and plotting scripts.
-  - `reader.py`: Script to read data from the RFID reader and write it to a file.
-  - `plotting.py`: Script to plot the RFID data.
-  - `__init__.py`: Marks the directory as a Python package.
-- **docs/**: Contains the documentation files.
-  - `01_Regular_Set_Up.md`: Guide for regular setup of the Zebra FX7500 RFID reader.
-  - `02_Network_Set_Up.md`: Guide for network setup of the Zebra FX7500 RFID reader.
-- **results/**: Directory where the RFID data files will be saved.
-- **assets/**: Contains images used in the documentation.
-- `main.py`: Main script to run the RFID reader.
-- `mqtt_set_up.sh`: Script to set up the MQTT broker.
-- `plots.ipynb`: Jupyter Notebook for plotting the RFID data.
-- `requirements.txt`: External dependencies.
+# 📡 RFID Reader FX7500
 
-## 🚀 Getting Started
+This repository contains the code and setup instructions for the Zebra FX7500 RFID Reader.
+
+## 📋 Table of Contents
+
+- [📡 RFID Reader FX7500](#-rfid-reader-fx7500)
+  - [📋 Table of Contents](#-table-of-contents)
+  - [🛠️ Regular Set Up](#️-regular-set-up)
+  - [🌐 Network Set Up](#-network-set-up)
+  - [📜 License](#-license)
+  - [📂 Project Structure](#-project-structure)
+  - [🚀 Getting Started](#-getting-started)
+  - [📄 Main Script](#-main-script)
+  - [📊 Plots](#-plots)
+
+## 🛠️ Regular Set Up
+
+For the regular setup of the Zebra FX7500 RFID Reader, please refer to the [Regular Set Up Guide](./docs/01_Regular_Set_Up.md).
+
+## 🌐 Network Set Up
 
-### Prerequisites
+For the network setup of the Zebra FX7500 RFID Reader, please refer to the [Network Set Up Guide](./docs/02_Network_Set_Up.md).
 
-- Python 3.6 or higher
-- MQTT broker (e.g., Mosquitto)
-- Zebra FX7500 RFID reader
+## 📜 License
 
-### Installation
+This project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for details.
 
-1. Clone the repository:
+## 📂 Project Structure
+
+```
+RFID-Reader-FX7500/
+├── docs/
+│   ├── 01_Regular_Set_Up.md
+│   └── 02_Network_Set_Up.md
+├── src/
+│   ├── reader.py
+│   └── plotting.py
+├── main.py
+├── mqtt_set_up.sh
+├── requirements.txt
+├── LICENSE
+└── README.md
+```
+
+## 🚀 Getting Started
+
+To get started with the Zebra FX7500 RFID Reader, follow these steps:
+
+1. **Clone the repository:**
 
    ```bash
    git clone https://github.com/yourusername/RFID-Reader-FX7500.git
    cd RFID-Reader-FX7500
    ```
 
-2. Install the required Python packages:
+2. **Install the required packages:**
 
    ```bash
    pip install -r requirements.txt
    ```
 
-### Usage
-
-1. Set up the MQTT broker:
+3. **Set up the MQTT broker:**
 
    ```bash
    ./mqtt_set_up.sh
    ```
 
-2. Run the main script:
+4. **Run the main script:**
 
    ```bash
    python main.py
    ```
 
-3. Plot the data using the Jupyter Notebook:
-
-   ```bash
-   jupyter notebook plots.ipynb
-   ```
-
-## 📄 Documentation
-
-- [Regular Set Up](./docs/01_Regular_Set_Up.md)
-- [Network Set Up](./docs/02_Network_Set_Up.md)
+## 📄 Main Script
 
-## 📊 Examples
+The main script is located at [main.py](./main.py). It includes the main flow of the program, imports necessary modules, and defines the main function.
 
-### Plotting Data
+## 📊 Plots
 
-To plot the RFID data, use the `plotting.py` script. For example:
+The plots are generated using the data from the RFID reader. The plotting script is located at [src/plotting.py](./src/plotting.py).
 
-```python
-import src.plotting as plt
-
-filename = './results/test.csv'
-plt.plot_data(filename)
-```
+For more details, refer to the [plots.ipynb](./plots.ipynb) notebook.