[add] readme
This commit is contained in:
parent
37e63b18d0
commit
daf8b36365
41
readme.md
Normal file
41
readme.md
Normal file
|
|
@ -0,0 +1,41 @@
|
||||||
|
# html-docwrap
|
||||||
|
|
||||||
|
reads an HTML string from `stdin`, wraps it into an HTML document with styling and prints the result to `stdout`
|
||||||
|
|
||||||
|
|
||||||
|
## Building
|
||||||
|
|
||||||
|
### Requirements
|
||||||
|
|
||||||
|
- shell interpreter
|
||||||
|
|
||||||
|
|
||||||
|
### Instructions
|
||||||
|
|
||||||
|
- execute `tools/build`
|
||||||
|
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
### Requirements
|
||||||
|
|
||||||
|
- shell interpreter
|
||||||
|
|
||||||
|
|
||||||
|
### Instructions
|
||||||
|
|
||||||
|
- as `root`, execute `tools/install`
|
||||||
|
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
### Requirements
|
||||||
|
|
||||||
|
- Python3 intpreter
|
||||||
|
|
||||||
|
|
||||||
|
### Instructions
|
||||||
|
|
||||||
|
- see `html-docwrap -h`
|
||||||
|
- example: `echo "<strong>Hello, World!</strong>" | html-docwrap`
|
||||||
|
|
||||||
Loading…
Reference in a new issue