Merge branch 'master' of http://git.tilde.town/tildetown/town-launcher
commit
9dbec05b3f
17
README.md
17
README.md
|
@ -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,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
|
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:
|
||||||
|
|
||||||
shortDesc: View the town's Acceptable Use Policy
|
```yaml
|
||||||
longDesc: |
|
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
|
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
|
Policies that governed servers like this in the past. It will open the elinks browser to a
|
||||||
page on the wiki.
|
page on the wiki.
|
||||||
examples: |
|
examples: |
|
||||||
$ town aup # open the aup
|
$ town aup # open the aup
|
||||||
$ town aup --rainbow # open the aup with rainbow colors
|
$ town aup --rainbow # open the aup with rainbow colors
|
||||||
maintainer: vilmibm
|
maintainer: vilmibm
|
||||||
|
```
|
||||||
|
|
||||||
and using the launcher is like:
|
and using the launcher is like:
|
||||||
|
|
||||||
|
|
Reference in New Issue