2018-01-14 19:22:10 +00:00
|
|
|
## Documentation overview
|
2014-03-08 22:32:32 +00:00
|
|
|
|
|
|
|
|
This page links the resources available for information on installing and
|
2018-01-14 19:22:10 +00:00
|
|
|
running, customizing and using bug.n, a list of changes made with the current
|
|
|
|
|
version and the Wiki pages available for additional information.
|
2014-03-08 22:32:32 +00:00
|
|
|
|
2014-03-08 22:46:57 +00:00
|
|
|
#### [README](../README.md)
|
2014-03-08 22:32:32 +00:00
|
|
|
> A description of what bug.n can do.
|
|
|
|
|
|
2014-03-08 22:46:57 +00:00
|
|
|
#### [CHANGES](./CHANGES.md)
|
2018-01-14 21:53:01 +00:00
|
|
|
> A list of changes to the user interface (i.a. configuration variables and
|
2014-03-08 22:32:32 +00:00
|
|
|
hotkeys) for each version of bug.n.
|
|
|
|
|
|
2014-03-08 22:46:57 +00:00
|
|
|
#### [Installing and running bug.n](./Installing_and_running.md)
|
2014-03-08 22:32:32 +00:00
|
|
|
> 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
|
2018-01-14 21:53:01 +00:00
|
|
|
Microsoft Windows higher than Vista.
|
2014-03-08 22:32:32 +00:00
|
|
|
|
2015-01-16 22:38:08 +00:00
|
|
|
##### [Stable version](../../../releases/latest)
|
2014-03-09 16:46:59 +00:00
|
|
|
> 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.
|
|
|
|
|
|
2015-01-16 22:38:08 +00:00
|
|
|
##### [Development version](../../../archive/master.zip)
|
2015-01-16 22:32:56 +00:00
|
|
|
> 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.
|
2014-03-09 16:46:59 +00:00
|
|
|
|
2014-03-08 22:32:32 +00:00
|
|
|
#### Usage
|
|
|
|
|
|
2014-03-08 22:46:57 +00:00
|
|
|
##### [Using bug.n](./Usage.md)
|
2014-03-08 22:32:32 +00:00
|
|
|
> A short introduction on how to use bug.n and on concepts, like layouts and
|
|
|
|
|
tagging, bug.n uses.
|
|
|
|
|
|
2014-03-08 22:46:57 +00:00
|
|
|
##### [Default hotkeys](./Default_hotkeys.md)
|
2014-03-08 22:32:32 +00:00
|
|
|
> A list of all hotkeys with their default mapping to functions and a short
|
|
|
|
|
description.
|
|
|
|
|
|
|
|
|
|
#### Customization
|
|
|
|
|
|
2014-03-08 22:46:57 +00:00
|
|
|
##### [Customizing bug.n](./Customization.md)
|
2014-03-08 22:32:32 +00:00
|
|
|
> A description on how to customize bug.n by setting configuration variables
|
2015-03-15 15:32:09 +00:00
|
|
|
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.
|
2014-03-08 22:32:32 +00:00
|
|
|
|
2014-03-08 22:46:57 +00:00
|
|
|
##### [Default setting of configuration variables](./Default_configuration.md)
|
2014-03-08 22:32:32 +00:00
|
|
|
> A list of all configuration variables with their default values and a short
|
|
|
|
|
description.
|
|
|
|
|
|
2014-03-08 22:46:57 +00:00
|
|
|
##### [Configuring rules](./Configuring_rules.md)
|
2014-03-08 22:32:32 +00:00
|
|
|
> A description of 'rules', bug.n uses for handling windows, and how they can
|
|
|
|
|
be set in `Config.ini`.
|
|
|
|
|
|
2014-03-08 22:46:57 +00:00
|
|
|
##### [Default hotkeys](./Default_hotkeys.md)
|
2014-03-08 22:32:32 +00:00
|
|
|
> A list of all hotkeys with their default mapping to functions and a short
|
|
|
|
|
description.
|
|
|
|
|
|
2014-03-08 22:46:57 +00:00
|
|
|
##### [Used hotkeys](./Used_hotkeys.md)
|
2014-03-08 22:32:32 +00:00
|
|
|
> 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.
|
|
|
|
|
|
2014-03-08 22:46:57 +00:00
|
|
|
##### [User proposed hotkeys](./User-hotkeys.md)
|
2014-03-08 22:32:32 +00:00
|
|
|
> Some individual hotkeys, proposed by bug.n users.
|
|
|
|
|
|
2014-03-08 22:46:57 +00:00
|
|
|
#### [LICENSE](../LICENSE.md)
|
2014-03-08 22:32:32 +00:00
|
|
|
> bug.n is licensed under the GNU General Public License version 3.
|
2015-01-16 22:09:11 +00:00
|
|
|
|
2015-01-16 23:21:43 +00:00
|
|
|
#### [CREDITS](./CREDITS.md)
|
2015-01-16 22:09:11 +00:00
|
|
|
> A list of people and projects, which contributed to bug.n.
|
2018-01-14 19:22:10 +00:00
|
|
|
|
|
|
|
|
### 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.
|
|
|
|
|
|
2018-01-15 16:42:55 +00:00
|
|
|
#### [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).
|
|
|
|
|
|
2018-01-14 19:22:10 +00:00
|
|
|
#### [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.
|
2018-01-15 12:21:00 +00:00
|
|
|
|
2018-01-15 12:34:14 +00:00
|
|
|
#### [Tutorials](https://github.com/fuhsjr00/bug.n/wiki/Tutorial-00.-Overview)
|
2018-01-15 12:21:00 +00:00
|
|
|
> Some tutorials explaining bug.n and its functionality in more detail.
|
