diff --git a/wiki/README.md b/wiki/README.md index 2d57fd1..e9cca6a 100644 --- a/wiki/README.md +++ b/wiki/README.md @@ -9,6 +9,7 @@ to contribute to the wiki: * clone the repo to your local machine (or your public_html folder on the tilde.team box for live testing) ```sh git clone git@tildegit.org:tildeverse/tilde.chat +cd tilde.chat ``` * create a new branch for your page @@ -18,9 +19,18 @@ git checkout -b my-new-page * if you want to add a new page, copy `template.md` into your new page! ```sh -cp template.md my-new-page.md +cp wiki/template.md wiki/my-new-page.md ``` +* test your changes locally +```sh +composer install +php -S localhost:9000 +``` + +this will run your site at http://localhost:9000/ + + * edit as needed! * commit your changes and [create a pull request](https://tildegit.org/tildeverse/tilde.chat/pulls) :) diff --git a/wiki/pages/bots.md b/wiki/pages/bots.md index 8812a84..7fcbe35 100644 --- a/wiki/pages/bots.md +++ b/wiki/pages/bots.md @@ -15,6 +15,9 @@ bots should be well behaved and efficient with system resources. if you see a bo ## rules and etiquette for tilde.chat irc bots +please set usermode +B on your bot on connect to identify it as a bot. +this is also documented in [rfc-2](https://rfc.tildeverse.org/rfcs/2#usermode--b). + your bot must respond to !botlist with the following information: - your system username (as creator/botmaster) - so we can contact you if the bot misbehaves - one line description of the bot's functionality