Go to file
Sam Therapy 4365f3b59c
Public Preview Builds / publish-preview (push) Successful in 44s Details
readme: Add docs link as badge
Signed-off-by: Sam Therapy <sam@samtherapy.net>
2024-03-27 16:09:32 +01:00
.config Add a docs site? 2024-03-27 15:15:18 +01:00
.forgejo/workflows fix GHA 2024-03-26 17:37:01 +01:00
.github ci: Fix perms, again 2024-03-27 15:48:52 +01:00
docs Add a docs site? 2024-03-27 15:15:18 +01:00
src readme: Add docs link as badge 2024-03-27 16:09:32 +01:00
.editorconfig refactor: Put FFI in its own project 2023-10-25 15:55:52 +02:00
.gitattributes feat: Initial commit 2023-05-13 20:10:14 +02:00
.gitignore Add a docs site? 2024-03-27 15:15:18 +01:00
GNUmakefile Bump more to .NET 8 2024-01-31 16:49:19 +01:00
LICENSE feat: Initial commit 2023-05-13 20:10:14 +02:00
README.md readme: Add docs link as badge 2024-03-27 16:09:32 +01:00
Xdg.Net.sln refactor: Rewrite everything 2023-10-25 15:55:57 +02:00
icon.png idk what all this is but it's a lot 2024-03-26 17:27:42 +01:00

README.md

Xdg.Directories

A .NET Standard library for the XDG Base Directory Specification and XDG user directories.

GitHub Actions Workflow Status NuGet Version Documentation MIT License

Xdg.Directories is a small (the .dll is only 11 KB), fast and portable (Completely supports .NET Standard 2.0 and even NativeAOT!) .NET implementation of the XDG Base Directory Specification and XDG user directories for Windows, MacOS and Linux/FreeBSD.

Full documentation can be found at https://xdg-net.github.io/Xdg.Directories.

Installation

Use NuGet to install Xdg.Directories.

From the .NET CLI:

dotnet add package Xdg.Directories

or from Visual Studio's package manager:

Install-Package Xdg.Directories

Pre-releases

Preview releases are uploaded to both GitHub packages (need GitHub account to download) and Forgejo packages (no login required).

Usage

Base Directories, C#

using System;
using Xdg.Directories;

// Prints /home/$USER/.local/share
Console.Writeline(BaseDirectory.DataHome);

// Prints /home/$USER/.cache
Console.Writeline(BaseDirectory.CacheHome)

User Directories, F#

open Xdg.Directories

// Prints /home/$USER/Documents
printfn "%s" UserDirectory.DesktopDir

License

This project is licensed under the MIT license.
Icon is made by Emoji One, CC BY-SA 4.0, via Wikimedia Commons an image.