From cdc18eade66c709498885157387e36209a4e1d4f Mon Sep 17 00:00:00 2001 From: Alfi Maulana Date: Fri, 24 Nov 2023 16:56:37 +0700 Subject: [PATCH 1/2] docs(readme): fill with project description --- README.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 11d92ae..5929691 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,14 @@ -# Project Starter +# CMake Starter -[![version](https://img.shields.io/github/v/release/threeal/project-starter?style=flat-square)](https://github.com/threeal/project-starter/releases) -[![license](https://img.shields.io/github/license/threeal/project-starter?style=flat-square)](./LICENSE) -[![build status](https://img.shields.io/github/actions/workflow/status/threeal/project-starter/ci.yaml?branch=main&style=flat-square)](https://github.com/threeal/project-starter/actions/workflows/ci.yaml) +[![version](https://img.shields.io/github/v/release/threeal/cmake-starter?style=flat-square)](https://github.com/threeal/cmake-starter/releases) +[![license](https://img.shields.io/github/license/threeal/cmake-starter?style=flat-square)](./LICENSE) +[![build status](https://img.shields.io/github/actions/workflow/status/threeal/cmake-starter/ci.yaml?branch=main&style=flat-square)](https://github.com/threeal/cmake-starter/actions/workflows/ci.yaml) -The Project Starter is a [GitHub repository template](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template) that provides a minimalistic boilerplate to kickstart any type of project on [GitHub](https://github.com/). Use this template to initialize your project with preconfigured settings recommended for various GitHub projects. +The CMake Starter is a [GitHub repository template](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template) that provides a minimalistic boilerplate to kickstart your [CMake](https://cmake.org/) project. +This template offers a streamlined foundation, complete with predefined file structures, essential tools, and recommended settings, ensuring a swift and efficient start to your CMake development journey. ## Features @@ -16,4 +17,4 @@ The Project Starter is a [GitHub repository template](https://docs.github.com/en ## Usage -Refer to [this wiki](https://github.com/threeal/project-starter/wiki) for information on how to use this template. +Refer to [this wiki](https://github.com/threeal/cmake-starter/wiki) for information on how to use this template. From c28ab8328f8da3f00123e69b1cde036034323501 Mon Sep 17 00:00:00 2001 From: Alfi Maulana Date: Fri, 24 Nov 2023 16:57:32 +0700 Subject: [PATCH 2/2] docs: remove guidance comments on most files --- .github/dependabot.yaml | 3 --- .github/workflows/ci.yaml | 3 --- .gitignore | 3 --- 3 files changed, 9 deletions(-) diff --git a/.github/dependabot.yaml b/.github/dependabot.yaml index c4d686c..678a1a6 100644 --- a/.github/dependabot.yaml +++ b/.github/dependabot.yaml @@ -7,6 +7,3 @@ updates: commit-message: prefix: chore labels: [chore] - - # You can add another configuration here to automatically update the other dependencies of your project. - # Learn more: https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml index ba6eb00..fdb4ffd 100644 --- a/.github/workflows/ci.yaml +++ b/.github/workflows/ci.yaml @@ -15,6 +15,3 @@ jobs: steps: - name: Checkout uses: actions/checkout@v4.1.1 - - # Add steps here to build and test your project. - # Learn more: https://docs.github.com/en/actions/automating-builds-and-tests diff --git a/.gitignore b/.gitignore index 0939290..df7ea1d 100644 --- a/.gitignore +++ b/.gitignore @@ -1,5 +1,2 @@ .* !.git* - -# Add additional glob patterns here to specify more files or directories to be ignored by Git. -# Learn more: https://git-scm.com/docs/gitignore