Skip to content

Commit

Permalink
docs(readme): add commit activity badge
Browse files Browse the repository at this point in the history
  • Loading branch information
sj-codedemo committed Jan 16, 2024
1 parent 0f9f13c commit 112641b
Showing 1 changed file with 29 additions and 5 deletions.
34 changes: 29 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,10 @@
<img src="https://img.shields.io/github/contributors/sj-codedemo/cookiecutter-coding-project-repo"
alt="contributors" />
</a>
<!-- Commit Activity -->
<a href="">
<img src="https://img.shields.io/github/commit-activity/w/sj-codedemo/cookiecutter-coding-project-repo"
alt="commit activity" />
<!-- Last Commit -->
<a href="">
<img src="https://img.shields.io/github/last-commit/sj-codedemo/cookiecutter-coding-project-repo"
Expand Down Expand Up @@ -117,11 +121,32 @@ screenshot from the project above this paragraph.
<!-- Prerequisites -->
### Prerequisites

* Python
<!-- 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

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

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
Expand All @@ -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 -->
### Usage

**To create a new project from this template:**

1. Run the following command to generate a new project from the template:

```bash
Expand All @@ -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

Expand Down

0 comments on commit 112641b

Please sign in to comment.