From 43440454af8b0a0d359eba54598178b4e636df98 Mon Sep 17 00:00:00 2001 From: Matthias Clasen Date: Tue, 8 Jan 2019 13:04:49 -0500 Subject: [PATCH] README: some Formatting tweaks Fix capitalization of Flatpak in a few places, and make directory names appear as such. Closes: #2545 Approved by: mwleeds --- README.md | 25 +++++++++++++------------ 1 file changed, 13 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index e9890dd6..daf5f95e 100644 --- a/README.md +++ b/README.md @@ -81,17 +81,18 @@ integration will not work. 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 -========== +# This repository -The flatpak project consists of multiple pieces, and it can be +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 +quick intro to the major components of the flatpak 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 + +