ahill/flatpak
1
0
Fork 0
mirror of https://github.com/flatpak/flatpak.git synced 2026-01-26 14:13:26 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add some docs for the overall git repo layout

Browse Source 
Trying to make things less confusing.

Closes: #2404
Approved by: alexlarsson
This commit is contained in:
Matthias Clasen 2018-12-07 15:34:14 -05:00 committed by Atomic Bot
parent d613bc0532
commit a8dff96aeb
1 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -79,3 +79,18 @@ location it is likely that this will not be found by dbus and
policykit. However, if the system installation is synchronized,
you can often use the system installed helper instead - at least
if the two versions are close in versions.
Floor plan
==========
The flatpak project consists of multiple pieces, and it can be
a bit challenging to find your way around at first. Here is a
quick intro to the major components of the repo:
* common: contains the library, libflatpak. It also contains various pieces of code that are shared between the library, the client and the services. Non-public code can be recognized by having a `-private.h` header file.
* app: the commandline client. Each command has a `flatpak-builtins-` source file
* data: D-Bus interface definition files
* session-helper: The flatpak-session-helper service, which provides various helpers for the sandbox setup at runtime
* system-helper: The flatpak-system-helper service, which runs as root on the system bus and allows non-root users to modify system installations
* portal: The Flatpak portal service, which lets sandboxed apps request the creation of new sandboxes
* doc: The sources for the documentation, both man pages and library documentation
* tests: The testsuite