Skip to content

Commit 99be579

Browse files
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
1 parent b3b1165 commit 99be579

File tree

1 file changed

+39
-0
lines changed

1 file changed

+39
-0
lines changed

README.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,5 +94,44 @@ You can contribute by adding new scripts, improving current scripts or Documenta
9494
Thanks goes to these wonderful people 😊
9595

9696
<a href="https://github.com/python-geeks/Automation-scripts/graphs/contributors">
97+
98+
## Installation and Setup
99+
100+
### Prerequisites
101+
- Python 3.7 or higher
102+
- pip (Python package manager)
103+
- Git
104+
105+
### Installation Steps
106+
107+
1. Clone the repository:
108+
```bash
109+
git clone https://github.com/python-geeks/Automation-scripts.git
110+
cd Automation-scripts
111+
```
112+
113+
2. Install required dependencies:
114+
```bash
115+
pip install -r requirements.txt
116+
```
117+
118+
3. Run a script:
119+
```bash
120+
python script_name.py
121+
```
122+
123+
## Documentation
124+
125+
For detailed documentation on each script, check the README files in the respective folders:
126+
- Each folder contains a README.md with specific usage instructions
127+
- Comments in the code explain complex logic
128+
- Examples are provided in the comments
129+
130+
## Troubleshooting
131+
132+
If you encounter any issues:
133+
1. Check the issue tracker to see if your problem has been reported
134+
2. Read the CONTRIBUTING.md file for contribution guidelines
135+
3. Open a new issue with detailed information about your problem
97136
<img src="https://contrib.rocks/image?repo=python-geeks/Automation-scripts" />
98137
</a>

0 commit comments

Comments
 (0)