Merge branch 'master' of http://git.tilde.town/tildetown/town-launcher
commit
9dbec05b3f
27
README.md
27
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,16 +13,17 @@ 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: |
|
||||
$ town aup # open the aup
|
||||
$ town aup --rainbow # open the aup with rainbow colors
|
||||
maintainer: vilmibm
|
||||
|
||||
```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: |
|
||||
$ town aup # open the aup
|
||||
$ town aup --rainbow # open the aup with rainbow colors
|
||||
maintainer: vilmibm
|
||||
```
|
||||
|
||||
and using the launcher is like:
|
||||
|
||||
|
|
Reference in New Issue