From 112641be9d62bce934fd8f632fe29a002e5ba353 Mon Sep 17 00:00:00 2001
From: sj-codedemo <141835690+sj-codedemo@users.noreply.github.com>
Date: Tue, 16 Jan 2024 09:40:30 +0000
Subject: [PATCH] docs(readme): add commit activity badge
---
README.md | 34 +++++++++++++++++++++++++++++-----
1 file changed, 29 insertions(+), 5 deletions(-)
diff --git a/README.md b/README.md
index ad8238a..96f09d9 100644
--- a/README.md
+++ b/README.md
@@ -36,6 +36,10 @@
+
+
+
### Prerequisites
-* Python
+
+- Python (3.7 or later)
+
+ Python is required for running Cookiecutter.
Visit [https://www.python.org/downloads/](https://www.python.org/downloads/) for installation instructions.
-* Cookiecutter
+
+- Git
+
+ Git is required for version control. If you don't have Git installed, you can download it from [Git's official website](https://git-scm.com/downloads).
+
+ - **Windows:** Download and install Git from [Git for Windows](https://gitforwindows.org/). During the installation, it's recommended to choose the option that adds Git to your PATH environment variable.
+
+ - **macOS:** You can install Git on macOS using the stand-alone installer or through package managers like [Homebrew](https://brew.sh/) by running `brew install git` in the terminal.
+
+ - **Linux:** Git can be installed on various Linux distributions using the default package manager. For example, on Ubuntu/Debian, use `sudo apt-get install git`, and on Fedora, use `sudo dnf install git`.
+
+ After installation, verify the installation by typing `git --version` in your terminal. This should display the installed version of Git.
+
+
+- Cookiecutter
+
+ Cookiecutter is a command-line utility that creates projects from templates. It can be installed via pip, Python's package manager. Ensure that you have pip installed before proceeding.
+
+ Install Cookiecutter using the following command:
```bash
pip install -U cookiecutter
@@ -130,11 +155,10 @@ screenshot from the project above this paragraph.
For other installation options and detailed instructions,
refer to the [Cookiecutter Installation Guide](https://cookiecutter.readthedocs.io/en/latest/installation.html).
+
### Usage
-**To create a new project from this template:**
-
1. Run the following command to generate a new project from the template:
```bash
@@ -143,7 +167,7 @@ screenshot from the project above this paragraph.
This command will clone the template from GitHub and prompt you to fill in specific project details.
-2. Follow the interactive prompts to customise your project's configuration.
+2. Generate the Project
- TODO: Add a gif of the interactive prompt steps
- TODO: Add a code block with the prompts and options