Skip to content
This repository was archived by the owner on Apr 15, 2025. It is now read-only.

Commit 9819457

Browse files
committed
Adjust template
1 parent 617da68 commit 9819457

File tree

18 files changed

+19
-211
lines changed

18 files changed

+19
-211
lines changed

.github/FUNDING.yml

Lines changed: 0 additions & 2 deletions
This file was deleted.

.github/workflows/cmake-multi-platform.yml

Lines changed: 0 additions & 65 deletions
This file was deleted.

.github/workflows/makefile.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,4 +15,4 @@ jobs:
1515
- uses: actions/checkout@v4
1616

1717
- name: Install dependencies
18-
run: cd project-name && make
18+
run: cd bitlab && make

.vscode/settings.json

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,9 @@
33
"cSpell.words": [
44
"codespaces",
55
"Doxygen",
6-
"Doxyfile"
6+
"Doxyfile",
7+
"bitlab",
8+
"Bitlab"
79
],
810
"editor.formatOnSave": true,
911
"editor.codeActionsOnSave": {
@@ -12,11 +14,5 @@
1214
"editor.formatOnSaveMode": "file",
1315
"editor.formatOnType": true,
1416
"editor.formatOnPaste": true,
15-
"editor.rulers": [
16-
200
17-
],
18-
"editor.tabSize": 4,
19-
"editor.wordWrap": "on",
20-
"editor.wordWrapColumn": 200,
2117
"makefile.configureOnOpen": true,
2218
}

CMakeLists.txt

Lines changed: 0 additions & 55 deletions
This file was deleted.

Doxyfile

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,19 +42,19 @@ DOXYFILE_ENCODING = UTF-8
4242
# title of most generated pages and in a few other places.
4343
# The default value is: My Project.
4444

45-
PROJECT_NAME = "Project Name"
45+
PROJECT_NAME = "Bitlab"
4646

4747
# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
4848
# could be handy for archiving the generated documentation or if some version
4949
# control system is used.
5050

51-
PROJECT_NUMBER = 0.0.1
51+
PROJECT_NUMBER = 0.0.0
5252

5353
# Using the PROJECT_BRIEF tag one can provide an optional one line description
5454
# for a project that appears at the top of each page and should give viewer a
5555
# quick idea about the purpose of the project. Keep the description short.
5656

57-
PROJECT_BRIEF = "Project Name Brief Description"
57+
PROJECT_BRIEF = "Bitlab Brief Description"
5858

5959
# With the PROJECT_LOGO tag one can specify a logo or an icon that is included
6060
# in the documentation. The maximum height of the logo should not exceed 55
@@ -949,7 +949,7 @@ WARN_LOGFILE =
949949
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
950950
# Note: If this tag is empty the current directory is searched.
951951

952-
INPUT = ./project-name \
952+
INPUT = ./bitlab \
953953
./README.md
954954

955955
# This tag can be used to specify the character encoding of the source files

README.md

Lines changed: 7 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -1,58 +1,18 @@
1-
# C/C++ Project Template
1+
# Bitlab
22

3-
[![Make](https://github.com/milosz275/c-cpp-template/actions/workflows/makefile.yml/badge.svg)](https://github.com/milosz275/c-cpp-template/actions/workflows/makefile.yml)
4-
[![CodeQL](https://github.com/milosz275/c-cpp-template/actions/workflows/codeql.yml/badge.svg)](https://github.com/milosz275/c-cpp-template/actions/workflows/codeql.yml)
5-
[![CMake on multiple platforms](https://github.com/milosz275/c-cpp-template/actions/workflows/cmake-multi-platform.yml/badge.svg)](https://github.com/milosz275/c-cpp-template/actions/workflows/cmake-multi-platform.yml)
6-
[![Doxygen Pages](https://github.com/milosz275/c-cpp-template/actions/workflows/doxygen-pages.yml/badge.svg)](https://github.com/milosz275/c-cpp-template/actions/workflows/doxygen-pages.yml)
7-
[![License](https://img.shields.io/github/license/milosz275/c-cpp-template)](LICENSE)
3+
[![Make](https://github.com/milosz275/bitlab/actions/workflows/makefile.yml/badge.svg)](https://github.com/milosz275/bitlab/actions/workflows/makefile.yml)
4+
[![CodeQL](https://github.com/milosz275/bitlab/actions/workflows/codeql.yml/badge.svg)](https://github.com/milosz275/bitlab/actions/workflows/codeql.yml)
5+
[![Doxygen Pages](https://github.com/milosz275/bitlab/actions/workflows/doxygen-pages.yml/badge.svg)](https://github.com/milosz275/bitlab/actions/workflows/doxygen-pages.yml)
6+
[![License](https://img.shields.io/github/license/milosz275/bitlab)](LICENSE)
87

98
![Logo](assets/logo.png)
109

11-
This is a template for C/C++ projects. It includes a Makefile for building either C or C++, a directory structure for organizing the source code, and a README.md file for documenting the project.
10+
Bitlab
1211

1312
## Table of Contents
1413

15-
- [Getting Started](#getting-started)
16-
- [Build](#build)
17-
- [Adjustments](#adjustments)
18-
- [Adding new directories](#adding-new-directories)
19-
- [Choosing C/C++](#choosing-cc)
20-
- [Doxygen Docs](#doxygen-docs)
21-
- [License](#license)
22-
2314
## Getting Started
2415

25-
To use this template click "Use this template" and create a new repository or open the template in a codespaces [or use this template here](https://github.com/new?template_name=c-cpp-template&template_owner=milosz275).
26-
27-
![use template screen](assets/use-template.png)
28-
29-
After the repository is recreated, please modify repo settings in order to GitHub Pages docs deploy workflow succeed. Select GitHub Actions as a source for build and deployment.
30-
31-
> [!IMPORTANT]
32-
> Even if your repository is private, deployed docs will be available publicly.
33-
34-
![github pages](assets/pages-settings.png)
35-
36-
## Build
37-
38-
Repository comes ready with out-of-the-box options for Makefile as well as CMake. Feel free to remove one that you won't need.
39-
40-
## Adjustments
41-
42-
### Adding new directories
43-
44-
Edit main [Makefile](https://github.com/milosz275/c-cpp-template/blob/main/Makefile) for build-ignored directories. Each other new directory is required to have Makefile. CMake is building project-name directory at this moment.
45-
46-
### Choosing C/C++
47-
48-
You cannot use both C and C++ at the same time using this template. Choose proper file format in the [project Makefile](https://github.com/milosz275/c-cpp-template/blob/main/project-name/Makefile) and adjust input files in the [Doxyfile](https://github.com/milosz275/c-cpp-template/blob/main/Doxyfile).
49-
50-
### Doxygen Docs
51-
52-
Adjust Doxygen Documentation page icon in [header.html](https://github.com/milosz275/c-cpp-template/blob/main/header.html) file in line 16.
53-
54-
![adjust ico file](assets/ico-file.png)
55-
5616
## License
5717

58-
This project is licensed under the MIT License - see the [LICENSE](https://github.com/milosz275/c-cpp-template/blob/main/LICENSE) file for details.
18+
This project is licensed under the MIT License - see the [LICENSE](https://github.com/milosz275/bitlab/blob/main/LICENSE) file for details.

assets/favicon.ico

-15 KB
Binary file not shown.

assets/ico-file.png

-29.4 KB
Binary file not shown.

assets/logo.png

-31.7 KB
Binary file not shown.

0 commit comments

Comments
 (0)