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

Merge branch 'master' of http://git.tilde.town/tildetown/town-launcher

master
vilmibm 2020-06-10 05:43:49 +00:00
parent 8115522703 98e3297d2e
commit 9dbec05b3f
1 changed files with 14 additions and 13 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:
/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,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
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
longDesc: |
This command will open our code of conduct, a type of document that evokes the Acceptable Use
@ -22,7 +23,7 @@ purpose of the yaml file is to provide documentation for your executable, so `au
$ town aup # open the aup
$ town aup --rainbow # open the aup with rainbow colors
maintainer: vilmibm
```
and using the launcher is like: