# WinDirStat - Windows Directory Statistics

## Copyright and licenses

* Copyright © 2003-2005 Bernhard Seifert (bseifert@users.sourceforge.net)
* Copyright © 2004-2016 WinDirStat team (windirstat.info)

The application itself is distributed under the terms of the [GPL v2](windirstat/res/license.txt), but parts of the source code are also available
under more lenient license terms.

The documentation/help is distributed under the terms of the GNU FDL.

*Note:* you are not at liberty to upgrade the GPL version to anything later
than v2 at this moment.

The logo and all derivatives are available under the terms of the Creative
Commons license [CC BY 3.0](http://creativecommons.org/licenses/by/3.0/).

## Description

WinDirStat is a program that allows you to find disk space hogs at a glance.
It achieves that by displaying a drive, drives or directories in a [treemap](https://en.wikipedia.org/wiki/Treemap)
that assigns bigger areas to bigger files and directories. Making those areas
visually separate by coloring and other means allows you to see literally at
a glance what the space hogs are and where to dig deeper.

The directory tree is simultanously shown as a treelist and as a treemap.
One can effortlessly gain an impression of the proportions on the hard disk(s).

### Major features

* 3 views, Directory tree, Treemap and Extension list, coupled with each other,
* Built-in cleanup actions including Open, Delete, Show Properties,
* User defined cleanup actions (command line based),
* Language is English by default; further translations can be added as
  resource DLLs,
* Online-Help,
* A little setup.exe which installs the files and shortcuts.

### Background

The original author of WinDirStat was Bernhard Seifert and it was inspired by
[KDirStat](http://kdirstat.sourceforge.net/) and [SequoiaView](http://w3.win.tue.nl/nl/onderzoek/onderzoek_informatica/visualization/sequoiaview/).
Design and many details are based on KDirStat, so WinDirStat is "a KDirStat re-programmed for MS Windows".

### WinDirStat Alternatives on other operating systems

Meanwhile alternatives also exist for OS X and many programs make use of
treemaps for a variety of visualization needs.

The [FLOSS](https://en.wikipedia.org/wiki/Alternative_terms_for_free_software) alternatives for other operating systems are thus:

* [KDirStat](http://kdirstat.sourceforge.net/) (Linux and virtually any \*nix that runs KDE/X11)
* [Disk Inventory X](http://www.derlien.com/) (OS X)
* [GrandPerspective](http://grandperspectiv.sourceforge.net/) (OS X)

We're not aware of an alternative for Windows at this moment, but

## Building from source

Please refer to the project Wiki page [Building](https://bitbucket.org/windirstat/windirstat/wiki/Building).

## Contributing

The project [Wiki](https://bitbucket.org/windirstat/windirstat/wiki/Home) on
Bitbucket features a whole section on the topic of contributing. If you don't
agree on the requirements, feel free to contact a project member regardless
before you put any substantial effort into your potential contribution.

To see a list of contributors, please check out [the contributors page](CONTRIBUTORS.md).

## Compatibility

WinDirStat currently runs on all flavors of Windows, but does have some
problems on more recent versions of Windows (8 and later) that will be
addresses by a future release.

## Logo

![WinDirStat logo](common/logo_256px.png)

The [logo](https://windirstat.info/logo.html) was generously designed and contributed to the project by Robin
"tuqueque" Marín. Follow him on Twitter [@tuquequeorg](https://twitter.com/tuquequeorg).

## Links

We currently have:

* a [website](https://windirstat.info/)
* a [blog](http://blog.windirstat.info/)
* are on Twitter as [@windirstat](https://twitter.com/windirstat)
* have a SubReddit [r/WinDirStat](http://www.reddit.com/r/WinDirStat/)

Find a more up-to-date list of links on the website and the blog at any point
in time.

### Contact - Kontakt - Контакт

* You may write us on the following page in either English, German or Russian: [contact](https://windirstat.info/contact.html)
* Ihr könnt uns auf der folgenden Webseite entweder auf Deutsch, Englisch oder Russisch schreiben: [Kontakt](https://windirstat.info/contact.html)
* Пишите нам на этом вебсайте на русском, на англиском или на немецком: [контакт](https://windirstat.info/contact.html) - **Указание:** давно в школе я учился русский язык. Но как писал это уже давно, поэтому может быть чтобы не все понимаю и наверно тоже не пишу бес ошыбок. Посмотрим.
