diff --git a/README.md b/README.md index 873ea61f1b9..4cc9f3008c2 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,10 @@ -#This is a new repo # My Python Eggs 🐍 😄 +[![CodeQL Python Security Scan (Top-N)](https://github.com/geekcomputers/Python/actions/workflows/Codeql.yml/badge.svg)](https://github.com/geekcomputers/Python/actions/workflows/Codeql.yml) +[![Python Checks](https://github.com/geekcomputers/Python/actions/workflows/python.yml/badge.svg)](https://github.com/geekcomputers/Python/actions/workflows/python.yml) +[![Dependabot Updates](https://github.com/geekcomputers/Python/actions/workflows/dependabot/dependabot-updates/badge.svg)](https://github.com/geekcomputers/Python/actions/workflows/dependabot/dependabot-updates) -
- -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: craig@geekcomputers.co.uk. +## Project readme +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: `craig@geekcomputers.co.uk.`
@@ -57,4 +58,51 @@ Feel free to explore the scripts and use them for your learning and automation n 42. [How to begin the journey of open source (first contribution)](https://www.youtube.com/watch?v=v2X51AVgl3o) - First Contribution of open source
-_**Note**: The content in this repository belongs to the respective authors and creators. I'm just providing a formatted README.md for better presentation._ +>[!NOTE] +>The content in this repository belongs to the respective authors and creators. I'm just providing a formatted README.md for better presentation. + +## How to Run? +1. **Clone the repository** + ```bash + git clone https://github.com/geekcomputers/Python.git + cd Python + ``` +2. **Choose a script to run** +Each script in this repository is standalone and can be executed directly. + +## Dependencies + +Most scripts in this repository rely **only on the Python standard library**, so they can usually run without installing extra packages. + +>[!IMPORTANT] +>Some scripts may require additional Python libraries. +>The repository provides a dependency file (e.g., `requirements.txt`) as a reference, but it **may not list all required packages**. +>Check each script's header or comments for any extra dependencies that may need manual installation. +> +>To install the listed dependencies, run: +> +>```bash +>pip install -r requirements.txt +>``` +> +>For any missing packages, install them manually: +> +>```bash +>pip install +>``` + +## python version support +>[!NOTE] +>**Python version support:** +>Most scripts currently run on **Python 3.6 and above**. +>In future releases, the minimum supported Python version will gradually be updated to **3.9 or later**. + +## License + +This project is licensed under the **MIT License**. + +You are free to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the project, +subject to the following conditions: + +- The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. +- 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.