aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to '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.