From 99be579240dfb73d699b8f24bc455cc1a42fd76a Mon Sep 17 00:00:00 2001 From: duvvuvenkataramana Date: Thu, 13 Nov 2025 14:33:49 +0530 Subject: [PATCH] Enhance README.md with installation and troubleshooting guides Added comprehensive documentation including: - Installation and Setup section with prerequisites - Step-by-step installation instructions with code examples - Documentation reference guide - Troubleshooting section Fixes #1030 - Improve documentation for automation scripts --- README.md | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) diff --git a/README.md b/README.md index 8325ef54b..f8e7d55cb 100644 --- a/README.md +++ b/README.md @@ -94,5 +94,44 @@ You can contribute by adding new scripts, improving current scripts or Documenta Thanks goes to these wonderful people 😊 + +## Installation and Setup + +### Prerequisites +- Python 3.7 or higher +- pip (Python package manager) +- Git + +### Installation Steps + +1. Clone the repository: + ```bash + git clone https://github.com/python-geeks/Automation-scripts.git + cd Automation-scripts + ``` + +2. Install required dependencies: + ```bash + pip install -r requirements.txt + ``` + +3. Run a script: + ```bash + python script_name.py + ``` + +## Documentation + +For detailed documentation on each script, check the README files in the respective folders: +- Each folder contains a README.md with specific usage instructions +- Comments in the code explain complex logic +- Examples are provided in the comments + +## Troubleshooting + +If you encounter any issues: +1. Check the issue tracker to see if your problem has been reported +2. Read the CONTRIBUTING.md file for contribution guidelines +3. Open a new issue with detailed information about your problem