Feat: added README.md
- added authors and description of crate
This commit is contained in:
parent
c2fdf88ed4
commit
641b47ebee
@ -1,7 +1,9 @@
|
|||||||
[package]
|
[package]
|
||||||
name = "headr"
|
name = "headr"
|
||||||
|
authors = ["Minh Tran <minh@minhtrannhat.com>"]
|
||||||
version = "0.1.0"
|
version = "0.1.0"
|
||||||
edition = "2021"
|
edition = "2021"
|
||||||
|
description = "Rust rewrite of BSD headr"
|
||||||
|
|
||||||
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
|
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
|
||||||
|
|
||||||
|
23
README.md
Normal file
23
README.md
Normal file
@ -0,0 +1,23 @@
|
|||||||
|
# Rust rewrite of BSD head
|
||||||
|
|
||||||
|
``` text
|
||||||
|
headr 0.1.0
|
||||||
|
Minh Tran <minh@minhtrannhat.com>
|
||||||
|
Rust rewrite of BSD headr
|
||||||
|
|
||||||
|
Usage: headr [OPTIONS] [FILE]...
|
||||||
|
Arguments:
|
||||||
|
[FILE]... Input file(s) [default: -]
|
||||||
|
|
||||||
|
Options:
|
||||||
|
-n, --lines <lines> Print the first K lines instead of the first 10 with the leading '-', print all but the last K lines of each file [default: 10]
|
||||||
|
-c, --bytes <bytes> print the first K bytes of each file; with the leading '-', print all but the last K lines of each file
|
||||||
|
-h, --help Print help
|
||||||
|
-V, --version Print version
|
||||||
|
```
|
||||||
|
|
||||||
|
## Build
|
||||||
|
`cargo build`
|
||||||
|
|
||||||
|
## Test
|
||||||
|
`./mk-outs.sh && cargo test`
|
Loading…
x
Reference in New Issue
Block a user