github/ouch
1
1
Fork 0
mirror of https://github.com/ouch-org/ouch.git synced 2025-06-07 12:05:46 +00:00
Code Issues 15 Packages Projects Releases Wiki Activity

Update README, add badges and fixes broken links

Browse Source
This commit is contained in:
João Marcos Bezerra 2021-09-17 03:31:18 -03:00 committed by GitHub
parent 06c69d4d8f
commit afa6db6e93
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -1,20 +1,24 @@
# Ouch! # Ouch!
[![crates.io](https://img.shields.io/crates/v/ouch.svg?style=for-the-badge&logo=rust)](https://crates.io/crates/ouch) [![license](https://img.shields.io/badge/license-MIT-blue.svg?style=for-the-badge&logo=Open-Source-Initiative&logoColor=ffffff)](https://github.com/ouch-org/ouch/blob/main/LICENSE)
<!-- ![ouch_image](https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcR5ilNDTFZZ-Vy_ctm2YyAe8Yk0UT7lB2hIhg&usqp=CAU) --> <!-- ![ouch_image](https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcR5ilNDTFZZ-Vy_ctm2YyAe8Yk0UT7lB2hIhg&usqp=CAU) -->
`ouch` stands for **Obvious Unified Compression Helper**, and works on _Linux_, _Mac OS_ and _Windows_. `ouch` stands for **Obvious Unified Compression Helper**, and works on _Linux_, _Mac OS_ and _Windows_.
It is a CLI tool to compress and decompress files that aims to be easy to use. It is a CLI tool to compress and decompress files that aims on ease of usage.
<!-- TODO --> <!-- TODO -->
<!-- - [Listing files](#Listing-the-elements-of-an-archive) --> <!-- - [Listing files](#Listing-the-elements-of-an-archive) -->
- [Installation](#Installation) - [Usage](#usage)
- [Usage](#Usage) - [Decompressing](#decompressing)
- [Decompressing files](#Decompressing-files) - [Compressing](#compressing)
- [Compressing files/directories](#Compressing-files-and-directories) - [Installation](#installation)
- [Supported Formats](#Supported-formats) - [Latest binary](#downloading-the-latest-binary)
- [Supported operating systems](#Supported-operating-systems) - [Compiling from source](#installing-from-source-code)
- [Supported Formats](#supported-formats)
- [Contributing](#contributing)
## Usage ## Usage
@ -34,7 +38,7 @@ You can redirect the decompression results to a folder with the `-o/--output` fl
```sh ```sh
# Create 'pictures' folder and decompress inside of it # Create 'pictures' folder and decompress inside of it
ouch 1.tar.gz 2.tar.gz -o pictures ouch a.zip -o pictures
``` ```
### Compressing ### Compressing
@ -59,8 +63,6 @@ ouch compress * files.zip
`ouch` checks for the extensions of the **output file** to decide which formats should be used. `ouch` checks for the extensions of the **output file** to decide which formats should be used.
Check the [list of all file extensions supported](#Supported-formats).
<!-- ### Listing the elements of an archive <!-- ### Listing the elements of an archive
* **Upcoming feature** * **Upcoming feature**