https://github.com/kde/kf5book
Repository for the development of the KDE Frameworks Cookbook
https://github.com/kde/kf5book
Last synced: about 2 months ago
JSON representation
Repository for the development of the KDE Frameworks Cookbook
- Host: GitHub
- URL: https://github.com/kde/kf5book
- Owner: KDE
- Created: 2015-09-18T16:59:04.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2022-07-12T20:53:04.000Z (almost 3 years ago)
- Last Synced: 2025-04-04T23:01:31.631Z (2 months ago)
- Language: C++
- Homepage: https://invent.kde.org/documentation/kf5book
- Size: 5.8 MB
- Stars: 8
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README
Awesome Lists containing this project
README
# The KDE Frameworks Cookbook
## Introduction
This repository uses a number of git submodules. To initialize, run
git submodule update --init
once after cloning the repository.
For more information about working with Git submodules, see
http://blogs.atlassian.com/2013/03/git-submodules-workflows-tips/
To install the snippetextractor, see
https://github.com/endocode/snippetextractor
Enjoy!
## Adding a New Chapter
For adding a new chapter for a framework called "myframework", you have to:
1. create a new folder named "myframework"
2. add a new file called "intro_myframework.in.md" to this folder (and optionally further such files later on)
3. add submodule
* git submodule add kde:myframework myframework/myframework
4. and commit your changes