Skip to content

Commit 9858a13

Browse files
committed
doc: Create README.md
1 parent 90e1ce2 commit 9858a13

File tree

1 file changed

+66
-0
lines changed

1 file changed

+66
-0
lines changed

README.md

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
# Parallel Disk Usage (pdu)
2+
3+
[![Test](https://github.com/KSXGitHub/parallel-disk-usage/workflows/Test/badge.svg)](https://github.com/KSXGitHub/parallel-disk-usage/actions?query=workflow%3ATest)
4+
[![Benchmark](https://github.com/KSXGitHub/parallel-disk-usage/actions/workflows/benchmark.yaml/badge.svg)](https://github.com/KSXGitHub/parallel-disk-usage/actions/workflows/benchmark.yaml)
5+
[![Clippy](https://github.com/KSXGitHub/parallel-disk-usage/actions/workflows/clippy.yaml/badge.svg)](https://github.com/KSXGitHub/parallel-disk-usage/actions/workflows/clippy.yaml)
6+
[![Code formatting](https://github.com/KSXGitHub/parallel-disk-usage/actions/workflows/fmt.yaml/badge.svg)](https://github.com/KSXGitHub/parallel-disk-usage/actions/workflows/fmt.yaml)
7+
[![Lint dependency graph](https://github.com/KSXGitHub/parallel-disk-usage/actions/workflows/cargo-deny.yaml/badge.svg)](https://github.com/KSXGitHub/parallel-disk-usage/actions/workflows/cargo-deny.yaml)
8+
[![Crates.io Version](https://img.shields.io/crates/v/parallel-disk-usage?logo=rust)](https://crates.io/crates/parallel-disk-usage)
9+
10+
Summarize disk usage of the set of files, recursively for directories.
11+
12+
## Description
13+
14+
`pdu` is a CLI program that renders a graphical chart for disk usages of files and directories, it is intended to replace [`dust`](https://github.com/bootandy/dust) and [`dutree`](https://github.com/nachoparker/dutree).
15+
16+
Both `dust` (v0.5.4) and `dutree` (v0.12.5) do not utilize the parallel computing capability of Rust to improve performance.
17+
18+
## Installation
19+
20+
### From GitHub
21+
22+
Go to the [GitHub Release Page](https://github.com/KSXGitHub/parallel-disk-usage/releases) and download a binary.
23+
24+
### From [crates.io](https://crates.io)
25+
26+
**Prerequisites:**
27+
* [`cargo`](https://github.com/rust-lang/cargo)
28+
29+
```sh
30+
cargo install parallel-disk-usage
31+
```
32+
33+
### From the [Arch User Repository](https://aur.archlinux.org)
34+
35+
**Prerequisites:**
36+
* An AUR helper, such as [`paru`](https://github.com/Morganamilo/paru)
37+
38+
```sh
39+
paru -S parallel-disk-usage-bin
40+
```
41+
42+
```sh
43+
paru -S parallel-disk-usage
44+
```
45+
46+
## Distributions
47+
48+
[![Packaging Status](https://repology.org/badge/vertical-allrepos/parallel-disk-usage.svg)](https://repology.org/project/parallel-disk-usage/versions)
49+
50+
## Similar programs
51+
52+
* **CLI:**
53+
* `du`
54+
* [`dust`](https://github.com/bootandy/dust)
55+
* [`dutree`](https://github.com/nachoparker/dutree)
56+
* **TUI:**
57+
* [`ncdu`](https://dev.yorhel.nl/ncdu)
58+
* [`gdu`](https://github.com/dundee/gdu)
59+
* [`godu`](https://github.com/viktomas/godu)
60+
* **GUI:**
61+
* [GNOME's Disk Usage Analyzer, a.k.a. `baobab`](https://wiki.gnome.org/action/show/Apps/DiskUsageAnalyzer)
62+
* Filelight
63+
64+
## License
65+
66+
[Apache 2.0](https://git.io/JGIAt) © [Hoàng Văn Khải](https://ksxgithub.github.io/).

0 commit comments

Comments
 (0)