From 641b47ebee70eb8d3caf778c05e511712c141ec4 Mon Sep 17 00:00:00 2001 From: minhtrannhat Date: Wed, 20 Sep 2023 21:52:26 -0400 Subject: [PATCH] Feat: added README.md - added authors and description of crate --- Cargo.toml | 2 ++ README.md | 23 +++++++++++++++++++++++ 2 files changed, 25 insertions(+) create mode 100644 README.md diff --git a/Cargo.toml b/Cargo.toml index d46314f..2e6feaa 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,7 +1,9 @@ [package] name = "headr" +authors = ["Minh Tran "] version = "0.1.0" edition = "2021" +description = "Rust rewrite of BSD headr" # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html diff --git a/README.md b/README.md new file mode 100644 index 0000000..dc04ee2 --- /dev/null +++ b/README.md @@ -0,0 +1,23 @@ +# Rust rewrite of BSD head + +``` text +headr 0.1.0 + Minh Tran +Rust rewrite of BSD headr + +Usage: headr [OPTIONS] [FILE]... +Arguments: + [FILE]... Input file(s) [default: -] + +Options: + -n, --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 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`