Merge branch 'main' of https://github.com/miguelob/TFG

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

CONTRIBUTING.md

@@ -1 +1 @@
-This is a free contributing project. Feel free to do pull request into the master branh
+This is a free contributing project. Feel free to do pull request into the master branch

README.md

@@ -87,9 +87,17 @@ $ pip install pickle-mixin
 $ pip install python-tk
 $ pip install pymodbus
 ```
+## Package
+This packages contain all the code and funtionality from the repository on a terminal based GUI.
+You can find the realeases on the [Releases website](https://github.com/miguelob/ICS-Hacking/releases). It is recommended to download the latest version. Inside this package you will find the requirements.txt that need to be installed before running the main.py, with the following command:
 
-## Contact
+`pip install -r requirements.txt`
+
+After installing the requirements, you can directly run the main.py and the terminal GUI will guide you throught the different functionalities.
 
-- **Email**: [email protected]
+
+## Contact
+- **Email 1**: [email protected]
+- **Email 2**: [email protected]
 - **Linkedin**: https://www.linkedin.com/in/miguel-oleo-blanco/
 - **YouTube**: https://www.youtube.com/c/Migueloleoblanco