Skip to content

Commit

Permalink
Added architecture diagram.
Browse files Browse the repository at this point in the history
  • Loading branch information
Jacob Dawid committed Jan 30, 2015
1 parent 4980c9d commit 7e03053
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,17 +41,30 @@ Formalities:
* The repository must contain a README.md file at root.

# For developers

![Architecture](https://github.com/cybercatalyst/qt-pods/blob/master/architecture.png "Architecture")

Each time you develop an app you will set up a Qt subdirs project.
Each pod you are using will be added as a git submodule, thus keeping track
of the commit-exact version of the pods you are using.

qt-pods will generate a pods.pri next to subdirs project. By design, all you need
qt-pods will generate a pods.pri next to the subdirs project. By design, all you need
to do is integrating the following statement into your target application's pro file:
```
include(../pods.pri)
```
The pods.pri will set up the include paths, linker flags against pods and even draw in the dependencies of pods via their pris.

Sometimes you want to have submodules that are not pods. In order to allow that, qt-pods manages all subdir targets in a separate file called pods-subdirs.pri.
Usually, if you start a new project from scratch using qt-pods, qt-pods will take care of that and create a subdirs pro with the repository name and include the
following statement:

```
include(pods-subdirs.pri)
```

If you have an existing project, you need to put in that line manually.

# Compile and install
Development takes places with the latest version of Qt. Before submitting a bug report, please check whether that occurs
with the latest version of Qt. If it doesn't, it is not a bug.
Expand Down
Binary file added architecture.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 7e03053

Please sign in to comment.