Skip to content

Commit 6fafa34

Browse files
authored
Update README.md
1 parent f5f6c49 commit 6fafa34

File tree

1 file changed

+48
-3
lines changed

1 file changed

+48
-3
lines changed

README.md

Lines changed: 48 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
# My Python Eggs 🐍 😄
22

3-
<hr>
4-
3+
## Project readme
54
I do not consider myself as a programmer. I create these little programs as experiments to play with Python, or to solve problems for myself. I would gladly accept pointers from others to improve, simplify, or make the code more efficient. If you would like to make any comments then please feel free to email me: `[email protected].`
65

76
<hr>
@@ -57,4 +56,50 @@ Feel free to explore the scripts and use them for your learning and automation n
5756
<hr>
5857

5958
>[!NOTE]
60-
>The content in this repository belongs to the respective authors and creators. I'm just providing a formatted README.md for better presentation._
59+
>The content in this repository belongs to the respective authors and creators. I'm just providing a formatted README.md for better presentation.
60+
61+
## How to Run?
62+
1. **Clone the repository**
63+
```bash
64+
git clone https://github.com/geekcomputers/Python.git
65+
cd Python
66+
```
67+
2. **Choose a script to run**
68+
Each script in this repository is standalone and can be executed directly.
69+
70+
## Dependencies
71+
72+
Most scripts in this repository rely **only on the Python standard library**, so they can usually run without installing extra packages.
73+
74+
>[!IMPORTANT]
75+
>Some scripts may require additional Python libraries.
76+
>The repository provides a dependency file (e.g., `requirements.txt`) as a reference, but it **may not list all required packages**.
77+
>Check each script's header or comments for any extra dependencies that may need manual installation.
78+
>
79+
>To install the listed dependencies, run:
80+
>
81+
>```bash
82+
>pip install -r requirements.txt
83+
>```
84+
>
85+
>For any missing packages, install them manually:
86+
>
87+
>```bash
88+
>pip install <package-name>
89+
>```
90+
91+
## python version support
92+
>[!NOTE]
93+
>**Python version support:**
94+
>Most scripts currently run on **Python 3.6 and above**.
95+
>In future releases, the minimum supported Python version will gradually be updated to **3.9 or later**.
96+
97+
## License
98+
99+
This project is licensed under the **MIT License**.
100+
101+
You are free to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the project,
102+
subject to the following conditions:
103+
104+
- The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
105+
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.

0 commit comments

Comments
 (0)