Author | Jamozed <[email protected]> |
Date | 2022-02-05 09:32:19 |
Commit | c1c576b6caeec758925328e1179da387b5a29870 |
Parent | b181413a6eccae60cac79c97db7d4c0d5194134f |
meta: Reformat README
Diffstat
M | README.md | | | 29 | +++++++++++++++-------------- |
1 files changed, 15 insertions, 14 deletions
diff --git a/README.md b/README.md index 055f54a..c8a4ea2 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,6 @@ -# OMKOV coreutils +# coreutils -> OMKOV implementations of core software utilities - -OMKOV coreutils implements many basic software utilities commonly found on -UNIX-like systems. +A collection of general software utilities commonly found on UNIX systems. ## Utilities @@ -44,20 +41,24 @@ UNIX-like systems. | wc | Word, line, and byte or character count | POSIX | | yes | Output a string repeatedly | | -Utilities marked with a '\*' may be incomplete or non-complaint. +- Utilities marked with an asterisk ('*') may be incomplete or non-complaint. + +## Usage + +**coreutils** is being developed on x86-64 Linux, and is untested elsewhere. + +### Dependencies -## Build Instructions +- CMake >= 3.12, to build -OMKOV coreutils uses CMake to build. -Binaries will be located in the `bin` directory. +### Building -### UNIX Build +To build **coreutils** on UNIX, run `BuildUNIX.sh`. -Run `BuildUNIX.sh`, or +### Running -```sh -cmake -S . -B build && cmake --build build -``` +For information on each utility see its respective manpage or use the `--help` +option. ## Meta