diff --git a/README.md b/README.md index 737d3b9..cf50f6c 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,68 @@ # Xdg ---- -[![Build](https://github.com/SamTherapy/Xdg.Net/actions/workflows/build-test.yaml/badge.svg)](https://github.com/SamTherapy/Xdg.Net/actions/workflows/build-test.yaml) -[![CodeQL](https://github.com/SamTherapy/Xdg.Net/actions/workflows/codeql.yml/badge.svg)](https://github.com/SamTherapy/Xdg.Net/actions/workflows/codeql.yml) +[![Drone Build Status](https://ci.git.froth.zone/api/badges/sam/Xdg.Net/status.svg)](https://ci.git.froth.zone/sam/Xdg.Net) +[![GitHub Actions Build](https://github.com/SamTherapy/Xdg.Net/actions/workflows/build-test.yaml/badge.svg)](https://github.com/SamTherapy/Xdg.Net/actions/workflows/build-test.yaml) +[![GitHub Actions CodeQL](https://github.com/SamTherapy/Xdg.Net/actions/workflows/codeql.yml/badge.svg)](https://github.com/SamTherapy/Xdg.Net/actions/workflows/codeql.yml) +![Nuget](https://img.shields.io/nuget/v/Xdg.Net) -A .NET implementation of the [XDG Base Directory Specification](https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html). \ No newline at end of file + +A .NET (and an experimental C-compatible FFI) implementation of the [XDG Base Directory Specification](https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html) and XDG user directories. + +## Default Locations + +If any of the respective XDG environment are specified, the variable will always be returned. +Otherwise, the value depends on the operating system. + +Inspiration is taken from the [Go implementation](https://github.com/adrg/xdg) for Windows and MacOS directories. + +
+Base Directory + +| Environment Variable | Windows | macOS | Linux/FreeBSD | +| --- | --- | --- | --- | +| `XDG_DATA_HOME` | `%LOCALAPPDATA%` | `$HOME/Library/Application Support` | `$HOME/.local/share` | +| `XDG_CONFIG_HOME` | `%LOCALAPPDATA%` | `$HOME/Library/Application Support` | `$HOME/.config` | +| `XDG_STATE_HOME` | `%LOCALAPPDATA%` | `$HOME/Library/Application Support` | `$HOME/.local/state` | +| `XDG_BIN_HOME` | `null` | `null` | `$HOME/.local/bin` | +| `XDG_DATA_DIRS` | `%APPDATA%:%PROGRAMDATA%` | `/Library/Application Support` | `/usr/local/share:/usr/share` | +| `XDG_CONFIG_DIRS` | `%LOCALAPPDATA%` | `$HOME/Library/Preferences:/Library/Application Support:/Library/Preferences` | `/etc/xdg` | +| `XDG_CACHE_HOME` | `%LOCALAPPDATA%` | `$HOME/Library/Application Support` | `$HOME/.config` | +| `XDG_RUNTIME_HOME` | `%LOCALAPPDATA%` | `$HOME/Library/Application Support` | `/run/user/$UID` | +
+ +
+User Directory + +User directories on Windows use [Known Folders](https://learn.microsoft.com/en-us/windows/win32/shell/known-folders) as a fallback. +| Environment Variable | Windows | macOS | Linux/FreeBSD | +| --- | --- | --- | --- | +| `XDG_DESKTOP_DIR` | `Desktop` | `$HOME/Desktop` | `$HOME/Desktop` | +| `XDG_DOWNLOAD_DIR` | `null` | `$HOME/Downloads` | `$HOME/Downloads` | +| `XDG_DOCUMENTS_DIR` | `My Documents` | `$HOME/Documents` | `$HOME/Documents` | +| `XDG_MUSIC_DIR` | `My Music` | `$HOME/Music` | `$HOME/Music` | +| `XDG_PICTURES_DIRS` | `My Pictures` | `$HOME/Pictures` | `$HOME/Pictures` | +| `XDG_VIDEOS_DIR` | `My Videos` | `$HOME/Movies` | `$HOME/Videos` | +| `XDG_TEMPLATES_DIR` | `Templates` | `$HOME/Templates` | `$HOME/Templates` | +| `XDG_PUBLICSHARE_DIR` | `%PUBLIC%` | `$HOME/Public` | `$HOME/Public` | +
+ +
+Extra Directories + +| | Windows | macOS | Linux/FreeBSD | +| --- | --- | --- | --- | +| Home | `%USERPROFILE%` | `$HOME` | `$HOME` | +
+ +## Packaging +Stable releases will be uploaded to nuget.org, and preview releases are uploaded to both [GitHub packages](https://github.com/SamTherapy/Xdg.Net/pkgs/nuget/Xdg.Directories) (need GitHub account to download) and [Gitea packages](https://git.froth.zone/sam/-/packages/nuget/xdg.directories) (no login required). + +```pwsh +dotnet add package Xdg.Directories +``` + +### Native Library +TODO: add documentation and examples for making and consuming the native library + +## License +[MIT](./LICENSE) \ No newline at end of file diff --git a/src/Xdg.Directories/Xdg.Directories.csproj b/src/Xdg.Directories/Xdg.Directories.csproj index b5a8ed4..af3b0f9 100644 --- a/src/Xdg.Directories/Xdg.Directories.csproj +++ b/src/Xdg.Directories/Xdg.Directories.csproj @@ -27,7 +27,7 @@ LICENSE True snupkg - xdg;base-directories;base-directory;xdg-base-directory; + xdg;base-directories;base-directory;xdg-base-directory;directory;freedesktop;cross-platform git true