Add Readme and requirements

dseichter · Apr 13, 2024 · ae24f18 · ae24f18
1 parent cc342f5
commit ae24f18
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,2 +1,23 @@
 # AWSManager
+
 Manage resources and services on AWS
+
+## Badges
+
+![pep8](https://github.com/dseichter/AWSManager/actions/workflows/pep8.yml/badge.svg)
+![trivy](https://github.com/dseichter/AWSManager/actions/workflows/trivy.yml/badge.svg)
+
+## Start development
+
+Create and activate an environment by running the following command:
+
+```python -m venv .venv```
+
+```.venv/Scripts/activate```
+
+Install the required dependencies
+
+```pip install -r src/requirements.txt```
+
+If you want to do some UI changes, download and install the latest wxFormBuilder from the [wxFormBuilder Homepage](https://github.com/wxFormBuilder/wxFormBuilder).
+
diff --git a/src/requirements.txt b/src/requirements.txt
@@ -0,0 +1,2 @@
+wxPython==4.2.1
+urllib3==2.2.1