|
1 |
| -# C/C++ Project Template |
| 1 | +# Bitlab |
2 | 2 |
|
3 |
| -[](https://github.com/milosz275/c-cpp-template/actions/workflows/makefile.yml) |
4 |
| -[](https://github.com/milosz275/c-cpp-template/actions/workflows/codeql.yml) |
5 |
| -[](https://github.com/milosz275/c-cpp-template/actions/workflows/cmake-multi-platform.yml) |
6 |
| -[](https://github.com/milosz275/c-cpp-template/actions/workflows/doxygen-pages.yml) |
7 |
| -[](LICENSE) |
| 3 | +[](https://github.com/milosz275/bitlab/actions/workflows/makefile.yml) |
| 4 | +[](https://github.com/milosz275/bitlab/actions/workflows/codeql.yml) |
| 5 | +[](https://github.com/milosz275/bitlab/actions/workflows/doxygen-pages.yml) |
| 6 | +[](LICENSE) |
8 | 7 |
|
9 | 8 | 
|
10 | 9 |
|
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 |
12 | 11 |
|
13 | 12 | ## Table of Contents
|
14 | 13 |
|
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 |
| - |
23 | 14 | ## Getting Started
|
24 | 15 |
|
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 |
| - |
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 |
| - |
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 |
| - |
55 |
| - |
56 | 16 | ## License
|
57 | 17 |
|
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. |
0 commit comments