From b561fe2c4eb97b7aafcfa7a8dfe4934c348f5f58 Mon Sep 17 00:00:00 2001 From: Leonard Eshun Date: Fri, 6 Sep 2024 19:54:15 -0400 Subject: [PATCH] More Readme updates --- README.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 437b1ff..1768c4b 100644 --- a/README.md +++ b/README.md @@ -14,20 +14,26 @@ The requirements are: 1. Housed in a public version control Source Code Management Repository (SCM) repository (GitHub, GitLab, BitBucket, Gitea, etc.) -## This is what the python code does: + +## This is what the python code does It has two functions: 1. **get_the_capital_of_a_country** to get the capital city of a country + ``` get_the_capital_of_a_country(country: str) -> str + ``` 1. **add** to add two numbers + ``` add(a, a) + ``` > [!TIP] > Just clone the repository to your local machine or codespace and enjoy. -## These are the steps followed: + +## Steps taken to meet the requirements The code was pushed to Github and Github Actions did the following main things: 1. Setup the virtual environment according to the parameters in the workflow.yml @@ -37,4 +43,4 @@ The code was pushed to Github and Github Actions did the following main things: 1. Finally all the tests in the test_main.py were executed > [!IMPORTANT] -> All the above steps had to be successful to get a completed CI. \ No newline at end of file +> All the above steps had to be successful to get a completed CI/CD. \ No newline at end of file