From 0e183dba366d1ffb0e1ff98a161981f3f6da6c64 Mon Sep 17 00:00:00 2001 From: Miguel Oleo Date: Wed, 31 Aug 2022 11:17:28 -0500 Subject: [PATCH 1/3] Update CONTRIBUTING.md --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f86a318..34996c6 100755 --- a/CONTRIBUTING.md +++ b/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 From d363af953b2679ab316187408783da50ad7d0714 Mon Sep 17 00:00:00 2001 From: Miguel Oleo Date: Wed, 31 Aug 2022 11:20:11 -0500 Subject: [PATCH 2/3] Update issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 38 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 ++++++++++++ 2 files changed, 58 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..dd84ea7 --- /dev/null +++ b/.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. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..bbcbbe7 --- /dev/null +++ b/.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. From 8c62bf8b11beccbbac721b4d7d8e902ae4bbc078 Mon Sep 17 00:00:00 2001 From: Miguel Oleo Date: Wed, 31 Aug 2022 11:27:16 -0500 Subject: [PATCH 3/3] Update README.md --- README.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b6d8f45..07aa7c7 100755 --- a/README.md +++ b/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**: miguel.oleo@alu.comillas.edu + +## Contact +- **Email 1**: moleoblanco@hawk.iit.edu +- **Email 2**: miguel.oleo@alu.comillas.edu - **Linkedin**: https://www.linkedin.com/in/miguel-oleo-blanco/ - **YouTube**: https://www.youtube.com/c/Migueloleoblanco