From cdef21ce0d1af3e467c661d07d0ace0dcbca8838 Mon Sep 17 00:00:00 2001 From: Ben Harris Date: Wed, 18 Jul 2018 15:20:56 -0400 Subject: [PATCH] update README --- README.md | 41 +++++++++++++---------------------------- 1 file changed, 13 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index cba04a0..eee051b 100644 --- a/README.md +++ b/README.md @@ -1,34 +1,19 @@ -# `tilde` - A tilde-launcher proposal in Python +# `tilde` - user script tilde-launcher -This is my proposal for the tilde town program launcher. Here are the features that make it compliant with the specs: +``` +wrapper for user-submitted scripts +supports user submission and admin approval - - 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) +usage: tilde [help|list|submit|about|] -Here are the things I have left to make before this proposal can be considered a true answer to the specs: + tilde list - show a list of approved userscripts + tilde submit - start the submission flow for your own script + tilde about - get the description for script_name + tilde - run script_name with all remaining args are passed to the script +``` - - [ ] Implement submit process - - [ ] Implement other commands shown in help example (see below) - - [ ] Polish some rough logic +approved scripts are placed in /tilde/bin and listed with `tilde list` -## Top-level commands +submissions use sendmail to notify an admin. - - [x] help - complete - - [x] contrib - complete - - [x] chat - complete - - [ ] mail - just need to write this one - - [ ] submit - See Questions below - -## Questions - -### `tilde submit` - - - How should this be accomplished? - - Is this supposed to be only for ben or for an admin in general to help? - - If the answer to the previous question is the latter, how should this be accomplished? - -## Requirements - -In `/tilde/special`, put: - - - `list` - see list program in this directory +admins can use `sudo tilde approve` and `sudo tilde revoke `.