README

directories

directories is anOCaml library that provides configuration, cache and data paths (and more!) following the suitable conventions onLinux,macOS andWindows. It is inspired by similar libraries for other languages such asdirectories-jvm.

The following conventions are used:

• XDG Base Directory Specification andxdg-user-dirs on Linux

• Known Folders on Windows

• Standard Directories on macOS

On Linux and macOS it has no dependency. On Windows, it depends only onctypes.

Quickstart

You should depend ondirectories then :

let () =  let module App_id = struct    let qualifier = "com"    let organization = "YourCompany"    let application = "yourapp"  end in  let module M = Directories.Project_dirs (App_id) in  let option_value = function None -> "None" | Some v -> v in  Format.printf "cache dir  = `%s`@." (option_value M.cache_dir);  Format.printf "config dir = `%s`@." (option_value M.config_dir);  Format.printf "data dir   = `%s`@." (option_value M.data_dir)

For more, have a look at theexample folder.

About

• LICENSE

• CHANGELOG

1. ctypes>= "0.17.1" & (os = "win32" | os = "cygwin")
2. ctypes-foreign>= "0.4.0" & (os = "win32" | os = "cygwin")
3. ocaml>= "4.07.0"
4. dune>= "2.1"

None

1. bogue= "20231209"
2. catapult-sqlite
3. ccbg
4. drom_lib
5. gotd
6. sun

None