tildetown
/
town-launcher
Archived
1
0
Fork 0
Code Issues 1 Pull Requests Releases Wiki Activity

Update 'README.md'

master^2
vilmibm 2020-06-08 22:14:50 +00:00
parent 24aaa81aea
commit 98e3297d2e
1 changed files with 13 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -3,9 +3,9 @@ commands.
The idea is to put town commands in one of three places: The idea is to put town commands in one of three places:
/town/launcher/core - /town/launcher/core
/town/launcher/contrib - /town/launcher/contrib
/town/launcher/admin - /town/launcher/admin
and pair each command with a corresponding .yml file. and pair each command with a corresponding .yml file.
@ -13,6 +13,7 @@ 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 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: purpose of the yaml file is to provide documentation for your executable, so `aup.yml` looks like:
```yaml
shortDesc: View the town's Acceptable Use Policy shortDesc: View the town's Acceptable Use Policy
longDesc: | longDesc: |
This command will open our code of conduct, a type of document that evokes the Acceptable Use This command will open our code of conduct, a type of document that evokes the Acceptable Use
@ -21,7 +22,7 @@ purpose of the yaml file is to provide documentation for your executable, so `au
examples: | examples: |
$ aup # open the aup $ aup # open the aup
$ aup --rainbow # open the aup with rainbow colors $ aup --rainbow # open the aup with rainbow colors
```
and using the launcher is like: and using the launcher is like: