intercal/markup
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update README with usage instructions

Browse Source 
Signed-off-by: Alek Ratzloff <alekratz@gmail.com>
This commit is contained in:
Alek Ratzloff
2022-09-22 10:12:02 -07:00
parent c6a18bcce7
commit e566b2e956
1 changed files with 10 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@@ -1,3 +1,12 @@
# markup # markup
A small, easy markup language for doing basic replacements in text. A small, easy markup language for doing basic replacements in text.
# Usage
If you want to use it inside of Python, you should be able to just drop in `markup.py` into your
Python program.
If you want to use it on the command line, you can either call `./markup.py` and pass your text to
process through STDIN. Otherwise, you can pass in a (single) file as an argument, e.g.
`./markup.py filename.txt`