From acc1b5a0b93eae05c5d5f0bccba85b652ca47075 Mon Sep 17 00:00:00 2001 From: msclock Date: Thu, 9 Nov 2023 12:11:27 +0800 Subject: [PATCH] chore: rename repository to ss-cpp Signed-off-by: msclock --- .devcontainer/devcontainer.json | 2 +- CMakeLists.txt | 4 ++-- CONTRIBUTING.md | 2 +- LICENSE | 2 +- README.md | 14 +++++++------- copier.yml | 12 ++++++------ docs/api.md | 2 +- docs/conf.py | 4 ++-- docs/index.md | 2 +- template/.gitignore.jinja | 2 +- template/CONTRIBUTING.md | 2 +- template/README.md.jinja | 6 +++--- .../index.md.jinja | 2 +- vcpkg.json | 2 +- 14 files changed, 29 insertions(+), 29 deletions(-) diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json index 47e682ce..b2b979f9 100644 --- a/.devcontainer/devcontainer.json +++ b/.devcontainer/devcontainer.json @@ -1,7 +1,7 @@ // For format details, see https://aka.ms/vscode-remote/devcontainer.json or this file's README at: // https://github.com/microsoft/vscode-dev-containers/tree/v0.195.0/containers/cpp { - "name": "cpp-scaffold", + "name": "ss-cpp", "image": "mcr.microsoft.com/devcontainers/base:jammy", "capAdd": [ // Enable ptrace-based debugging for C++ diff --git a/CMakeLists.txt b/CMakeLists.txt index 4dcfab92..638b206e 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -19,9 +19,9 @@ set(VCPKG_VERBOSE # Project settings project( - cpp-scaffold + ss-cpp LANGUAGES CXX C - HOMEPAGE_URL "https://github.com/msclock/cpp-scaffold" + HOMEPAGE_URL "https://github.com/serious-scaffold/ss-cpp" DESCRIPTION "A development-focused Cpp project template.") set(CMAKE_CXX_STANDARD 20) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 28b40747..b695d876 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -26,7 +26,7 @@ As usual: - create a new branch: `git switch -c feature-or-bugfix-name` - edit the code and/or the documentation -- run `copier copy --vcs-ref=HEAD -l . .` to generate the current cpp-scaffold. +- run `copier copy --vcs-ref=HEAD -l . .` to generate the current repository. - run `pre-commit run -a` to check if any errors can be fixed. - if everything is fine, your changes are ready to commit. diff --git a/LICENSE b/LICENSE index 8f3ead03..ac4fb552 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2022-2023 msclock +Copyright (c) 2022-2023 Serious Scaffold Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index 6e1abaf5..e8f31ca2 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,12 @@ -# Cpp Scaffold +# SS Cpp A development-focused Cpp project template. -[![GitHub CI Status](https://github.com/msclock/cpp-scaffold/actions/workflows/ci.yml/badge.svg)](https://github.com/msclock/cpp-scaffold/actions/workflows/ci.yml) -[![GitHub Release](https://img.shields.io/github/v/release/msclock/cpp-scaffold)](https://github.com/msclock/cpp-scaffold/releases) -[![GitHub License](https://img.shields.io/github/license/msclock/cpp-scaffold)](https://github.com/msclock/cpp-scaffold/blob/master/LICENSE) +[![GitHub CI Status](https://github.com/serious-scaffold/ss-cpp/actions/workflows/ci.yml/badge.svg)](https://github.com/serious-scaffold/ss-cpp/actions/workflows/ci.yml) +[![GitHub Release](https://img.shields.io/github/v/release/serious-scaffold/ss-cpp)](https://github.com/serious-scaffold/ss-cpp/releases) +[![GitHub License](https://img.shields.io/github/license/serious-scaffold/ss-cpp)](https://github.com/serious-scaffold/ss-cpp/blob/master/LICENSE) [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit) -[![cpp Scaffold](https://img.shields.io/badge/cpp%20scaffold-c++-blue)](https://github.com/msclock/cpp-scaffold) +[![SS Cpp](https://img.shields.io/badge/Serious%20Scaffold-c++-blue)](https://github.com/serious-scaffold/ss-cpp) ## Features @@ -24,7 +24,7 @@ A development-focused Cpp project template. 1. Generate the project. ```bash - copier copy gh:msclock/cpp-scaffold /path/to/project + copier copy gh:serious-scaffold/ss-cpp /path/to/project ``` 2. Navigate to the project directory and initialize a git repository. @@ -45,4 +45,4 @@ A development-focused Cpp project template. ## 📜 License -MIT License, for more details, see the [LICENSE](https://github.com/msclock/cpp-scaffold/blob/master/LICENSE) file. +MIT License, for more details, see the [LICENSE](https://github.com/serious-scaffold/ss-cpp/blob/master/LICENSE) file. diff --git a/copier.yml b/copier.yml index c00cbc5a..0973b8b8 100644 --- a/copier.yml +++ b/copier.yml @@ -20,13 +20,13 @@ _message_after_update: | you're done. project_name: - default: Cpp Scaffold + default: SS Cpp help: 'Enter the name of the project in CamelCase format:' type: str project_description: default: | - [%- if project_name == 'Cpp Scaffold' -%] + [%- if project_name == 'SS Cpp' -%] A development-focused Cpp project template. [%- endif -%] help: 'Provide a brief description for the project:' @@ -53,7 +53,7 @@ copyright_year: author_name: default: | - [%- if project_name == 'Cpp Scaffold' -%] + [%- if project_name == 'SS Cpp' -%] msclock [%- endif -%] help: 'Specify the name of the author:' @@ -61,8 +61,8 @@ author_name: organization_name: default: | - [%- if project_name == 'Cpp Scaffold' -%] - msclock + [%- if project_name == 'SS Cpp' -%] + Serious Scaffold [%- endif -%] help: 'Provide the name of the organization associated with the project:' type: str @@ -74,7 +74,7 @@ copyright_holder: author_email: default: | - [%- if project_name == 'Cpp Scaffold' -%] + [%- if project_name == 'SS Cpp' -%] msclock@126.com [%- else -%] {{ author_name }}@{{ organization_name|lower|replace(" ", "-") }}.com diff --git a/docs/api.md b/docs/api.md index b8331252..9c2450d9 100644 --- a/docs/api.md +++ b/docs/api.md @@ -3,5 +3,5 @@ This documentation was generated by Doxygen + Breathe ```{doxygenindex} -:project: cpp-scaffold_doxygen +:project: ss-cpp_doxygen ``` diff --git a/docs/conf.py b/docs/conf.py index 27d6e8dc..ea3d91d7 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -17,8 +17,8 @@ # -- Project information ----------------------------------------------------- -project = "Cpp Scaffold" -copyright = "2022-2023 msclock" +project = "SS Cpp" +copyright = "2022-2023 Serious Scaffold" author = "msclock" # -- General configuration --------------------------------------------------- diff --git a/docs/index.md b/docs/index.md index 27818fe5..413921ba 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,4 +1,4 @@ -# Welcome to Cpp Scaffold's documentation +# Welcome to SS Cpp's documentation ```{toctree} :hidden: diff --git a/template/.gitignore.jinja b/template/.gitignore.jinja index 2003b197..09cc4c5f 100644 --- a/template/.gitignore.jinja +++ b/template/.gitignore.jinja @@ -339,7 +339,7 @@ ASALocalRun/ .nox .mypy_cache -[% if repo_name == 'cpp-scaffold' -%] +[% if repo_name == 'ss-cpp' -%] # Ignore things from copier .copier-answers.yml [%- endif %] diff --git a/template/CONTRIBUTING.md b/template/CONTRIBUTING.md index 28b40747..b695d876 100644 --- a/template/CONTRIBUTING.md +++ b/template/CONTRIBUTING.md @@ -26,7 +26,7 @@ As usual: - create a new branch: `git switch -c feature-or-bugfix-name` - edit the code and/or the documentation -- run `copier copy --vcs-ref=HEAD -l . .` to generate the current cpp-scaffold. +- run `copier copy --vcs-ref=HEAD -l . .` to generate the current repository. - run `pre-commit run -a` to check if any errors can be fixed. - if everything is fine, your changes are ready to commit. diff --git a/template/README.md.jinja b/template/README.md.jinja index ad8f0cbf..8727f6a4 100644 --- a/template/README.md.jinja +++ b/template/README.md.jinja @@ -10,9 +10,9 @@ {{ release_badge() }} {{ license_badge() }} [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit) -[![cpp Scaffold](https://img.shields.io/badge/cpp%20scaffold-c++-blue)](https://github.com/msclock/cpp-scaffold) +[![SS Cpp](https://img.shields.io/badge/Serious%20Scaffold-c++-blue)](https://github.com/serious-scaffold/ss-cpp) -[% if repo_name == 'cpp-scaffold' -%] +[% if repo_name == 'ss-cpp' -%] ## Features - Project setup and template update with [copier](https://github.com/copier-org/copier/). @@ -29,7 +29,7 @@ 1. Generate the project. ```bash - copier copy gh:msclock/cpp-scaffold /path/to/project + copier copy gh:{{ repo_namespace }}/ss-cpp /path/to/project ``` 2. Navigate to the project directory and initialize a git repository. diff --git a/template/[% if docs_type == 'sphinx' %]docs[% endif %]/index.md.jinja b/template/[% if docs_type == 'sphinx' %]docs[% endif %]/index.md.jinja index cd809002..591c3eae 100644 --- a/template/[% if docs_type == 'sphinx' %]docs[% endif %]/index.md.jinja +++ b/template/[% if docs_type == 'sphinx' %]docs[% endif %]/index.md.jinja @@ -3,7 +3,7 @@ ```{toctree} :hidden: Overview -[% if repo_name == 'cpp-scaffold' -%] +[% if repo_name == 'ss-cpp' -%] cmake_workflow [% endif -%] changelog diff --git a/vcpkg.json b/vcpkg.json index cae0c8b7..f6d150e5 100644 --- a/vcpkg.json +++ b/vcpkg.json @@ -1,6 +1,6 @@ { "$schema": "https://raw.githubusercontent.com/microsoft/vcpkg-tool/main/docs/vcpkg.schema.json", - "name": "cpp-scaffold", + "name": "ss-cpp", "description": "A development-focused Cpp project template.", "builtin-baseline": "cc97b4536ae749ec0e4f643488b600b217540fb3", "dependencies": [