tilde-launcher/README.md

44 lines
1.5 KiB
Markdown
Raw Permalink Normal View History

2018-06-08 20:36:51 +00:00
# `tilde` - A tilde-launcher proposal in Python
2018-02-20 00:59:49 +00:00
2018-06-08 20:36:51 +00:00
This is my proposal for the tilde town program launcher. Here are the features that make it compliant with the specs:
2018-02-20 00:59:49 +00:00
2018-06-08 20:36:51 +00:00
- It has a help menu that, while not meeting the format of the specs, gives an example usage string and description.
- It implements the contrib system beautifully (IMO)
2018-02-20 00:59:49 +00:00
2018-06-08 20:36:51 +00:00
Here are the things I have left to make before this proposal can be considered a true answer to the specs:
2018-02-20 00:59:49 +00:00
2018-06-08 20:36:51 +00:00
- [ ] Implement submit process
- [ ] Implement other commands shown in help example (see below)
- [ ] Polish some rough logic
2018-02-20 00:59:49 +00:00
2018-06-08 20:36:51 +00:00
## Top-level commands
2018-02-20 00:59:49 +00:00
2018-06-08 20:36:51 +00:00
- [X] help - complete
- [X] contrib - complete
- [X] chat - complete
- [ ] mail - just need to write this one
- [ ] page - see Questions section below
- [ ] poetry - just need to write this one to work with prosaic (I assume)
- [ ] submit - probably can use the same mechanic as page (unless a volunteer admin could be tasked with this, in which case, this would submit to the volunteer portal
- [ ] toot and tweet - just need to write these
- [ ] wiki - not gonna lie, just going to wrap the wiki tool as it exists on this one; you want thin, you got it
2018-02-20 00:59:49 +00:00
2018-06-08 20:36:51 +00:00
## Questions
2018-02-20 00:59:49 +00:00
2018-06-08 20:36:51 +00:00
### `tilde page`
2018-02-20 00:59:49 +00:00
2018-06-08 20:36:51 +00:00
- How should this be accomplished?
- Is this supposed to be only for vilmibm or for an admin in general to help?
- If the answer to the previous question is the latter, how should this be accomplished?
2018-02-20 00:59:49 +00:00
2018-06-08 20:36:51 +00:00
### `tilde submit`
2018-02-20 00:59:49 +00:00
2018-06-08 20:36:51 +00:00
Same as above.
2018-02-20 00:59:49 +00:00
2018-06-08 20:36:51 +00:00
## Requirements
2018-02-20 00:59:49 +00:00
2018-06-08 20:36:51 +00:00
In `/tilde/special`, put:
2018-02-20 00:59:49 +00:00
2018-06-08 20:36:51 +00:00
- `chat` - launches IRC (however you want to do it)
- `list` - see list program in this directory