Glee Docs
=========

This is the official user-facing Glee documentation. If you are a developer,
you can see the internal documentation by running
	
	cargo doc --open

The Glee server-side software explicitly only supports Linux and the BSDs.

Conventions
-----------

Inside the documentation we will use shorthand familiar to modern Unix-like operating systems. Sometimes our shorthand can cause ambiguity, so we document all such cases now.

- ~/.config vs $XDG_CONFIG_HOME: Whenever the documentation writes ~/.config, it really means "$XDG_CONFIG_HOME, but fall back to ~/.config if the variable is not set", since this is what the code does.