diff options
| author | Sebastian Thiel <sthiel@thoughtworks.com> | 2019-06-01 15:54:54 +0530 |
|---|---|---|
| committer | Sebastian Thiel <sthiel@thoughtworks.com> | 2019-06-01 15:54:54 +0530 |
| commit | 0ae156e5a1b6e3f7be2c61cba2a882d8a8a933c4 (patch) | |
| tree | 01dc16fc882aa32223be8eb6eab046788d21e57d /README.md | |
| parent | 310cd6af912cda7333496d5d5d80a68d6ea9b155 (diff) | |
Udpate readme
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 45 |
1 files changed, 43 insertions, 2 deletions
@@ -1,5 +1,46 @@ DUA (-> Disk Usage Analyzer) is a tool to conveniently learn about the usage of memory of a given directory. It's parallel by default and will max out your SSD, providing relevant information as fast as possible. -### Tasks +### Installation -* [ ] Simple CLI to list top-level directories similar to sn-sort +Via `cargo`, which can be obtained using [rustup][rustup] + +``` +cargo install dua-cli +``` + +### Usage + +```bash +# count the space used in the current working directory +dua +# count the space used in all directories that are not hidden +dua * +# learn about additional functionality +dua aggregate --help +``` + +### Roadmap + +#### 2.0 + +A sub-command bringing up a terminal user interface to allow drilling into directories, and clearing them out, all just using the keyboard. + +#### 1.0 + +Simple CLI to list top-level directories similar to sn-sort, but faster and more tailored to getting an idea of where most space is used. + +### Development + +#### Run tests + +```bash +make journey-tests +``` + +#### Learn about other targets + +``` +make +``` + +[rustup]: https://rustup.rs/ |