aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAdrian Kummerlaender2016-04-03 19:57:56 +0200
committerAdrian Kummerlaender2016-04-03 19:57:56 +0200
commitbcee386b79f54e67193957e4ddd0345568871e00 (patch)
tree64a576e52291636519b48273b5ad4a0f9fde53ac
parentecab2aa84ab1993b7ca3f6d258767cb136312a3b (diff)
downloadjustify-bcee386b79f54e67193957e4ddd0345568871e00.tar
justify-bcee386b79f54e67193957e4ddd0345568871e00.tar.gz
justify-bcee386b79f54e67193957e4ddd0345568871e00.tar.bz2
justify-bcee386b79f54e67193957e4ddd0345568871e00.tar.lz
justify-bcee386b79f54e67193957e4ddd0345568871e00.tar.xz
justify-bcee386b79f54e67193957e4ddd0345568871e00.tar.zst
justify-bcee386b79f54e67193957e4ddd0345568871e00.zip
Add basic README.md
-rw-r--r--README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..019ee1e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,14 @@
+# justify
+
+...is a single purpose program for block justification of UTF-8 encoded monospace text.
+
+Textual input is read from _STDIN_ and written to _STDOUT_ in its justified form. The default output width of 60 characters may be customized via the first application argument.
+
+## Build
+
+ mkdir build
+ cd build
+ cmake ..
+ make
+
+A current C++ compiler with support for C++14 is required.