From 90bc744d516f565a84fc62ab04eab0eba3797e86 Mon Sep 17 00:00:00 2001 From: Ismo Vuorinen Date: Fri, 11 Aug 2023 10:20:24 +0300 Subject: [PATCH] chore(docs): rework readme --- .github/README.md | 69 +++++++++++++++++++++++++++++++---------------- 1 file changed, 46 insertions(+), 23 deletions(-) diff --git a/.github/README.md b/.github/README.md index e1cd5d3..5c734b7 100644 --- a/.github/README.md +++ b/.github/README.md @@ -68,28 +68,51 @@ The folder structure follows [XDG Base Directory Specification][xdg] where possi | `$XDG_DATA_HOME` | `$HOME/.local/share` | User-specific data files | | `$XDG_STATE_HOME` | `$HOME/.local/state` | App state that should persist between restarts | -- `$XDG_BIN_HOME` defines directory that contains local binaries. -- `$XDG_DATA_HOME` defines the base directory relative to which user-specific data - files should be stored. - - If `$XDG_DATA_HOME` is either not set or empty, a default equal to - `$HOME/.local/share` should be used. -- `$XDG_CONFIG_HOME` defines the base directory relative to which user-specific - configuration files should be stored. - - If `$XDG_CONFIG_HOME` is either not set or empty, a default equal to `$HOME/.config` should be used. -- `$XDG_STATE_HOME` defines the base directory relative - to which user-specific state files should be stored. - - If `$XDG_STATE_HOME` is either not set or empty, a default equal to `$HOME/.local/state` should be used. -- The `$XDG_STATE_HOME` contains state data that should persist between (application) restarts, - but that is not important or portable enough to the user that it should be stored in `$XDG_DATA_HOME`. - - It may contain: - - actions history (logs, history, recently used files, …) - - current state of the application that can be reused - on a restart (view, layout, open files, undo history, …) -- User-specific executable files may be stored in `$HOME/.local/bin`. - Distributions should ensure this directory shows up in the UNIX `$PATH` - environment variable, at an appropriate place. -- `$XDG_DATA_DIRS` defines the preference-ordered set of base directories - to search for data files in addition to the `$XDG_DATA_HOME` base directory. - The directories in `$XDG_DATA_DIRS` should be seperated with a colon ':'. +#### XDG_BIN_HOME (`$HOME/.local/bin`) + +`$XDG_BIN_HOME` defines directory that contains local binaries. + +User-specific executable files may be stored in `$HOME/.local/bin`. +Distributions should ensure this directory shows up in the UNIX `$PATH` +environment variable, at an appropriate place. + +#### XDG_DATA_HOME (`$HOME/.local/share`) + +`$XDG_DATA_HOME` defines the base directory relative to which +user-specific *data files* should be stored. + +If `$XDG_DATA_HOME` is either not set or empty, +a default equal to `$HOME/.local/share` should be used. + +#### XDG_CONFIG_HOME (`$HOME/.config`) + +`$XDG_CONFIG_HOME` defines the base directory relative to which +user-specific *configuration files* should be stored. + +If `$XDG_CONFIG_HOME` is either not set or empty, +a default equal to `$HOME/.config` should be used. + +#### XDG_STATE_HOME (`$HOME/.local/state`) + +`$XDG_STATE_HOME` defines the base directory relative to which +user-specific *state files* should be stored. + +If `$XDG_STATE_HOME` is either not set or empty, +a default equal to `$HOME/.local/state` should be used. + +The `$XDG_STATE_HOME` contains *state data* that should +*persist between (application) restarts*, but that is not important or +portable enough to the user that it should be stored in `$XDG_DATA_HOME`. + +- It may contain: + - actions history (logs, history, recently used files, …) + - current state of the application that can be reused + on a restart (view, layout, open files, undo history, …) + +#### XDG_DATA_DIRS + +`$XDG_DATA_DIRS` defines the preference-ordered set of base directories +to search for data files in addition to the `$XDG_DATA_HOME` base directory. +The directories in `$XDG_DATA_DIRS` should be seperated with a colon ':'. [xdg]: https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html