sttemp

commit 2c0b390e2a9d0ae39d5161183e85543ccd7c1280
parent 978a3a66d0a0ee35c1d790e6ac68a3e4bab93c5f
Author: Anton Konyahin <me@konyahin.xyz>
Date:   Sun,  9 Jan 2022 19:58:01 +0300

make readme file from man page

Diffstat:
D
README
 | 
4
----
A
README.md
 | 
42
++++++++++++++++++++++++++++++++++++++++++

2 files changed, 42 insertions(+), 4 deletions(-)
diff --git a/README b/README
@@ -1,4 +0,0 @@
-STTEMP
-------
-
-Simple template manager.
diff --git a/README.md b/README.md
@@ -0,0 +1,42 @@
+# NAME
+
+sttemp - simple template manager
+
+# SYNOPSIS
+
+**sttemp** \[**-h**\]
+
+**sttemp** \[**-e**\] **template** \[**output**\]
+
+# DESCRIPTION
+
+**sttemp** copy file from your template directory and fill all
+substitutions with user input, or environment variables. Template
+directory and substitution pattern described in **src/config.h** file,
+in suckless style. You can use **\~** as **first** symbol of your path,
+for relative path from your home directory.
+
+# OPTIONS
+
+**-h**
+
+:   displays help information
+
+**-e**
+
+:   use environment variables for fill substitution in template, if
+    **sttemp** can\'t find environment variable with needed name, it
+    will use user input
+
+**template**
+
+:   name of file in your templates directory, which will use to create
+    new file
+
+**output**
+
+:   name of target file, if omit - sttemp will use template name
+
+# AUTHOR
+
+Anton Konyahin \<me\@konyahin.xyz>