From 412a3138a8a014865eef80c92e05be15351ece97 Mon Sep 17 00:00:00 2001 From: ubergeek Date: Mon, 4 Nov 2019 19:12:10 -0500 Subject: [PATCH 1/3] Update 'README.md' --- README.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index fb93436..2d06d1f 100644 --- a/README.md +++ b/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 \ No newline at end of file +* None yet \ No newline at end of file From 5661fb5da733519a03fa0ad19d9516e82a350c39 Mon Sep 17 00:00:00 2001 From: ubergeek Date: Mon, 4 Nov 2019 19:13:22 -0500 Subject: [PATCH 2/3] Update 'README.md' --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 2d06d1f..014db25 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ # Bash TDP Generator -TDP is an acronym for "Tilde Description Protocol", as described in [TDP RFC](http://protocol.club/~datagrok/beta-wiki/tdp.html). +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: From 94e033cf8059f57622b09e25b21ffb7e41e65962 Mon Sep 17 00:00:00 2001 From: ubergeek Date: Mon, 4 Nov 2019 19:13:54 -0500 Subject: [PATCH 3/3] Update 'README.md' --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 014db25..92d105e 100644 --- a/README.md +++ b/README.md @@ -4,11 +4,12 @@ TDP is an acronym for *Tilde Description Protocol*, as described in [TDP RFC](ht ## 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 +`./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 +`./gen_tdp > tilde.json` And then copy that file to where it needs to be.