Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Populate README with Project Description #2

Merged
merged 2 commits into from
Nov 24, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 0 additions & 3 deletions .github/dependabot.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
3 changes: 0 additions & 3 deletions .github/workflows/ci.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
3 changes: 0 additions & 3 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -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
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
<!-- Clear the content of this file and replace it with the description of your project. -->
<!-- Learn more: https://www.makeareadme.com -->

# 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

Expand All @@ -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.