diff --git a/docs/project-goals.txt b/docs/project-goals.txt new file mode 100644 index 0000000..4713c57 --- /dev/null +++ b/docs/project-goals.txt @@ -0,0 +1,51 @@ +--- Probotic + +A IRC Bot that is able to recieve several commands and on a weekly +(or daily, biweekly, monthly) basis will (privately?) declare an +assignment for users to do. + +--- Speculations + +Internally this suggests that it must handle entries of these projects +that could be preconceived or composed exactly for a given date (what + we're doing.) + +This may be done via a simplistic append-only database or a SQL-based +database. + +--- Requirements + +The bot should support printing at a regular interval or at a given date. +The bot should respect some commands, such as POST, for if someone wishes +to post a project challenge. +The bot should respect an administrator, such that he could POST, and +REMOVE entered items. +Command SEARCH, SINCE and LIST, for regexp searching, entries since a +date (presumably a relationship), and a list all. + +The tooling behind the bot should be accessible to do the same sort of +interfacing to recieve a given task at the running of a command (to avoid +having to deal with unix mail, this could be done through a daily check +in a crontab file.) + +--- Autism + +Formatting is BSD spc2, always bracketed (unless the block is upon another + keyword), overwrap functions and combinators. + +--- Example + +int /* what I meant by overwrap functions */ +main(int argc, + argv * argv) +{ + int * somevar = 0 + 1; + if (1 || /* what I meant by overwrap combinators */ + *somevar) + { return 0; } + else /* switch, if, do/while/for, would not be nested within */ + { + puts("fruakk"); + return 1; + } +}