Update 'README.md'
This commit is contained in:
parent
faccd9b2c3
commit
412a3138a8
14
README.md
14
README.md
|
@ -1,6 +1,16 @@
|
|||
# Bash TDP Generator
|
||||
TDP is an acronym for "Tilde Description Protocol", as described in [TDP RFC](http://protocol.club/~datagrok/beta-wiki/tdp.html).
|
||||
|
||||
## How To Use
|
||||
Clone the repo. Edit setenvs.sh, and set the appropriate values for your tilde server. After that is complete, do the following:
|
||||
|
||||
```./gen_tdp | json_pp
|
||||
|
||||
If it's valid json, json_pp should just parse it, and make you a nice json struct. If that is all good, then do this:
|
||||
|
||||
```./gen_tdp > tilde.json
|
||||
|
||||
And then copy that file to where it needs to be.
|
||||
|
||||
## ToDo
|
||||
* Make a separate config file
|
||||
* Add info header
|
||||
* None yet
|
Loading…
Reference in New Issue