Update README.md

README.md

@@ -1,15 +1,48 @@
 # C/C++ Project Template
 
-[![Make](https://github.com/mldxo/c-cpp-template/actions/workflows/makefile.yml/badge.svg)](https://github.com/mldxo/c-cpp-template/actions/workflows/makefile.yml)
-[![CodeQL](https://github.com/mldxo/c-cpp-template/actions/workflows/codeql.yml/badge.svg)](https://github.com/mldxo/c-cpp-template/actions/workflows/codeql.yml)
-[![CMake on multiple platforms](https://github.com/mldxo/c-cpp-template/actions/workflows/cmake-multi-platform.yml/badge.svg)](https://github.com/mldxo/c-cpp-template/actions/workflows/cmake-multi-platform.yml)
-[![Doxygen Pages](https://github.com/mldxo/c-cpp-template/actions/workflows/doxygen-pages.yml/badge.svg)](https://github.com/mldxo/c-cpp-template/actions/workflows/doxygen-pages.yml)
-[![License](https://img.shields.io/github/license/mldxo/c-cpp-template)](LICENSE)
+[![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)
+[![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)
+[![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)
+[![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)
+[![License](https://img.shields.io/github/license/milosz275/c-cpp-template)](LICENSE)
 
 ![Logo](assets/logo.png)
 
 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.
 
 ## Getting Started
 
-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=mldxo).
+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).
+
+![use template screen](assets/use-template.png)
+
+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.
+
+> [!IMPORTANT]
+> Even if your repository is private, deployed docs will be available publicly.
+
+![github pages](assets/pages-settings.png)
+
+## Build
+
+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.
+
+## Adjustments
+
+### Adding new directories
+
+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.
+
+### Choosing C/C++
+
+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).
+
+### Doxygen Docs
+
+Adjust Doxygen Documentation page icon in [header.html](https://github.com/milosz275/c-cpp-template/blob/main/header.html) file in line 16.
+
+![adjust ico file](assets/ico-file.png)
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](https://github.com/milosz275/c-cpp-template/blob/main/LICENSE) file for details.