summaryrefslogtreecommitdiff
path: root/hitomezashi-rs.1
diff options
context:
space:
mode:
Diffstat (limited to 'hitomezashi-rs.1')
-rw-r--r--hitomezashi-rs.123
1 files changed, 23 insertions, 0 deletions
diff --git a/hitomezashi-rs.1 b/hitomezashi-rs.1
new file mode 100644
index 0000000..f08e9e3
--- /dev/null
+++ b/hitomezashi-rs.1
@@ -0,0 +1,23 @@
+.TH HITOMEZASHI-RS "1" "April 2024" "hitomezashi-rs v1.0.0"
+.SH NAME
+hitomezashi-rs \- generates classic two-colored Hitomezashi stitch patterns.
+.SH SYNOPSIS
+hitomezashi-rs <WIDTH> <HEIGHT>
+.SH DESCRIPTION
+Hitomezashi-rs is a fast, portable generator of classic, two-colored Hitomezashi stitch patterns.
+
+A classic Hitomezashi stitch pattern consists of dashed horizontal and vertical lines which form random patterns. This program outputs the two-colored version of those patterns.
+.SH OPTIONS
+\-h, \-\-help
+.TP
+\-v, \-\-version
+.TP
+\-s, \-\-skew <number from 0 to 1 inclusive>
+.RS 4
+The closer the skew value is to 0 or 1, the more orderly the patterns. The default skew value is 0.5, the value that yields the most disordered patterns.
+.SH AUTHOR
+Written by Nicholas Johnson.
+.SH REPORTING BUGS
+Report bugs to nick@nicholasjohnson.ch
+.SH COPYRIGHT
+Copyright © 2024 Nicholas Johnson. License GPLv3+: GNU GPL version 3 or later <https://gnu.org/licenses/gpl.html>. This is free software: you are free to change and redistribute it. There is NO WARRANTY, to the extent permitted by law.