## Documentation overview

This page links the resources available for information on installing and
running, customizing and using bug.n, a list of changes made with the current 
version and the Wiki pages available for additional information.

#### [README](../README.md)
> A description of what bug.n can do.

#### [CHANGES](./CHANGES.md)
> A list of changes to the user interface (i.a. configuration variables and
hotkeys) for each version of bug.n.

#### [Installing and running bug.n](./Installing_and_running.md)
> A description of how to install and run bug.n. Also described is a method to
run bug.n as Administrator to solve problems with the User Access Control of
Microsoft Windows higher than Vista.

##### [Stable version](../../../releases/latest)
> The current stable version of bug.n as a package (`.zip` file); it includes
the source, a compiled version as one executable and the corresponding
documentation for that version.

##### [Development version](../../../archive/master.zip)
> The development version of bug.n as a package (`.zip` file); it includes the
source, a compiled version as one executable and the corresponding documentation
for the current development status.

#### Usage

##### [Using bug.n](./Usage.md)
> A short introduction on how to use bug.n and on concepts, like layouts and
tagging, bug.n uses.

##### [Default hotkeys](./Default_hotkeys.md)
> A list of all hotkeys with their default mapping to functions and a short
description.

#### Customization

##### [Customizing bug.n](./Customization.md)
> A description on how to customize bug.n by setting configuration variables
and hotkeys. Also described is a method to re-use the hotkey <kbd>Win</kbd><kbd>L</kbd>,
which is blocked by the Windows function to lock the screen.

##### [Default setting of configuration variables](./Default_configuration.md)
> A list of all configuration variables with their default values and a short
description.

##### [Configuring rules](./Configuring_rules.md)
> A description of 'rules', bug.n uses for handling windows, and how they can
be set in `Config.ini`.

##### [Default hotkeys](./Default_hotkeys.md)
> A list of all hotkeys with their default mapping to functions and a short
description.

##### [Used hotkeys](./Used_hotkeys.md)
> An overview of those hotkeys, already in use by bug.n with the default
configuration. With this overview you may find unused keys, which can be used
for non-bug.n hotkeys or to reassign bug.n functions.

##### [User proposed hotkeys](./User-hotkeys.md)
> Some individual hotkeys, proposed by bug.n users.

#### [LICENSE](../LICENSE.md)
> bug.n is licensed under the GNU General Public License version 3.

#### [CREDITS](./CREDITS.md)
> A list of people and projects, which contributed to bug.n.

### Wiki

#### [Configuration examples](https://github.com/fuhsjr00/bug.n/wiki/Configuration-examples)
> Some configuration examples given as a `Config.ini` and shown by a 
screenshot.

#### [Default hotkeys cheat sheet](https://github.com/fuhsjr00/bug.n/wiki/Default-hotkeys_cheat-sheet.pdf)
> A cheat sheet giving an overview of the default hotkeys on one page (PDF).

#### [Documentation](https://github.com/fuhsjr00/bug.n/wiki/Documentation)
> The documentation in the `doc` directory of the repository, which is also 
linked above.

#### [Q&A](https://github.com/fuhsjr00/bug.n/wiki/Q&A)
> Some questions and answers regarding bug.n and window management in general.

#### [Tutorials](https://github.com/fuhsjr00/bug.n/wiki/Tutorial-00.-Overview)
> Some tutorials explaining bug.n and its functionality in more detail.