From 98e3297d2ed53843bddbd49fca2171a6eee00821 Mon Sep 17 00:00:00 2001 From: vilmibm Date: Mon, 8 Jun 2020 22:14:50 +0000 Subject: [PATCH] Update 'README.md' --- README.md | 25 +++++++++++++------------ 1 file changed, 13 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 321275c..71d30de 100644 --- a/README.md +++ b/README.md @@ -3,9 +3,9 @@ commands. The idea is to put town commands in one of three places: -/town/launcher/core -/town/launcher/contrib -/town/launcher/admin +- /town/launcher/core +- /town/launcher/contrib +- /town/launcher/admin and pair each command with a corresponding .yml file. @@ -13,15 +13,16 @@ For example, the `aup` command is a simple wrapper around elinks that opens our put the executable `aup` in /town/launcher/core and matched it with /town/launcher/aup.yml. The purpose of the yaml file is to provide documentation for your executable, so `aup.yml` looks like: - shortDesc: View the town's Acceptable Use Policy - longDesc: | - This command will open our code of conduct, a type of document that evokes the Acceptable Use - Policies that governed servers like this in the past. It will open the elinks browser to a - page on the wiki. - examples: | - $ aup # open the aup - $ aup --rainbow # open the aup with rainbow colors - +```yaml +shortDesc: View the town's Acceptable Use Policy +longDesc: | + This command will open our code of conduct, a type of document that evokes the Acceptable Use + Policies that governed servers like this in the past. It will open the elinks browser to a + page on the wiki. +examples: | + $ aup # open the aup + $ aup --rainbow # open the aup with rainbow colors +``` and using the launcher is like: