this repo has no description
docs: cleanup of the README
+19
-18
+19
-18
README.md
+19
-18
README.md
···
1
1
# cmprss
2
2
3
3
**Status: Alpha.**
4
-
CLI is stable but likely contains bugs, and may have breaking changes.
4
+
CLI is relatively stable but likely contains bugs, and there may be future breaking changes.
5
5
6
6
A compression multi-tool for the CLI.
7
7
Replace `tar` with something you can remember.
8
8
[Relevant XKCD](https://xkcd.com/1168/).
9
9
10
+
Currently supports:
11
+
12
+
- gzip
13
+
- tar
14
+
- xz
15
+
10
16
## Usage
11
17
12
18
The primary goal of the CLI is to make it easy and consistent to work with any compression format.
13
19
All of the examples will work with _any_ of the supported compression formats.
14
-
Some formats will fail in certain scenarios, as not all compression formats support all types of input/output; for example `tar` is unable to support compressing from `stdin` and extracting to `stdout`, because it expects to operate on files.
20
+
Though some formats will fail in certain scenarios as not all compression formats support all types of input/output.
21
+
For example `tar` is unable to support compressing from `stdin` and extracting to `stdout`, because it expects to operate on files.
15
22
16
23
All commands read from left to right, input is always either piped from `stdin` or the first filename(s) specified, and output is either `stdout` or the last filename/directory.
17
24
···
22
29
Compress a file/directory to a `tar` archive:
23
30
24
31
```bash
25
-
cmprss tar filename # outputs to archive.tar
32
+
cmprss tar filename # outputs to filename.tar
26
33
cmprss tar filename my_preferred_output_name.tar
27
34
```
28
35
···
30
37
31
38
```bash
32
39
cmprss tar dir_1/ dir_2/ combined.tar
33
-
cmprss tar file_1.txt file_2.txt # outputs to archive.tar
40
+
cmprss tar file_1.txt file_2.txt # outputs to file_1.txt.tar
34
41
```
35
42
36
43
Extract a `tar` archive:
···
45
52
Create and extract a `tar.gz` archive with pipes:
46
53
47
54
```bash
48
-
cmprss tar directory_name | cmprss gzip > directory.tar.gz
49
-
cmprss gzip --extract directory.tar.gz | cmprss tar --extract new_directory
55
+
cmprss tar directory | cmprss gzip > directory.tar.gz
56
+
cmprss gzip --extract directory.tar.gz | cmprss tar -e new_directory
50
57
51
58
# Or a full roundtrip in one line
52
59
cmprss tar directory_1/ directory_2/ | cmprss gzip | cmprss gzip -e | cmprss tar -e new_directory
53
60
```
54
61
55
-
## Supported formats
62
+
## Contributing
56
63
57
-
- gzip
58
-
- tar
59
-
- xz
60
-
61
-
# Contributing
62
-
63
-
## Development Environment
64
+
### Development Environment
64
65
65
66
The primary supported developer environment is defined in the `flake.nix` file.
66
67
This is a [Nix Flake](https://nixos.wiki/wiki/Flakes) that pins versions of all packages used by `cmprss`.
···
72
73
73
74
If you run into any issues developing with either the Nix environment or a stable Rust environment, please open a Github issue with the details.
74
75
75
-
## Conventional Commits
76
+
### Conventional Commits
76
77
77
78
Commits should conform to the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) standard.
78
79
79
-
## Test Coverage
80
+
### Test Coverage
80
81
81
82
PRs that improve the test coverage are encouraged.
82
83
83
84
Test coverage can be measured using `cargo llvm-cov report` and `cargo tarpaulin`.
84
85
85
-
## @arcuru
86
+
### @arcuru
86
87
87
88
I am the only developer on this right now, and I usually develop by committing directly to the `main` branch.
88
89
For larger features I _may_ go through a PR to run CI and to have some more easily discoverable documentation of a specific feature.
89
90
90
-
I will stop commiting directly to `main` as soon as someone else submits a non-trivial PR and then submits a request to remove this section of the README.
91
+
I will stop committing directly to `main` as soon as someone else submits a non-trivial PR and then submits a request to remove this section of the README.