Skip to content
/ kf5book Public

Repository for the development of the KDE Frameworks Cookbook

Notifications You must be signed in to change notification settings

KDE/kf5book

Repository files navigation

# 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