GitHub/pbot
3
0
Fork 0
mirror of https://github.com/pragma-/pbot.git synced 2024-11-26 05:49:27 +01:00
Code Issues Projects Releases Wiki Activity

README.md: minor improvements

Browse Source
This commit is contained in:
Pragmatic Software 2020-01-20 22:43:08 -08:00
parent cada72fdb2
commit 4d1b6e0610
1 changed files with 41 additions and 42 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

83
README.md
View File

@ -1,43 +1,41 @@
PBot # PBot
----
PBot is a versatile IRC Bot written in Perl PBot is a versatile IRC Bot written in Perl
<!-- md-toc-begin --> <!-- md-toc-begin -->
* [PBot](#pbot) * [Installation / Quick Start](#installation--quick-start)
* [Installation / Quick Start](#installation--quick-start) * [Features](#features)
* [Features](#features) * [Commands](#commands)
* [Commands](#commands) * [Advanced interpreter](#advanced-interpreter)
* [Advanced interpreter](#advanced-interpreter) * [piping](#piping)
* [piping](#piping) * [command substitution](#command-substitution)
* [command substitution](#command-substitution) * [command splitting](#command-splitting)
* [command splitting](#command-splitting) * [advanced $variable interpolation](#advanced-variable-interpolation)
* [advanced $variable interpolation](#advanced-variable-interpolation) * [inline commands](#inline-commands)
* [inline commands](#inline-commands) * [Factoids](#factoids)
* [Factoids](#factoids) * [Code Factoids](#code-factoids)
* [Code Factoids](#code-factoids) * [Plugins](#plugins)
* [Plugins](#plugins) * [Modules](#modules)
* [Modules](#modules) * [Virtual machine](#virtual-machine)
* [Virtual machine](#virtual-machine) * [Useful IRC command improvements](#useful-irc-command-improvements)
* [Useful IRC command improvements](#useful-irc-command-improvements) * [Channel management](#channel-management)
* [Channel management](#channel-management) * [Admin management](#admin-management)
* [Admin management](#admin-management) * [Easy configuration](#easy-configuration)
* [Easy configuration](#easy-configuration) * [Documentation](#documentation)
* [Documentation](#documentation) * [Support](#support)
* [Support](#support) * [License](#license)
* [License](#license)
<!-- md-toc-end --> <!-- md-toc-end -->
Installation / Quick Start ## Installation / Quick Start
--------------------------
To get up-and-running quickly, check out the [Quick Start guide](doc/QuickStart.md). To get up-and-running quickly, check out the [Quick Start guide](doc/QuickStart.md).
Features ## Features
--------
### Commands ### Commands
PBot has several useful core built-in commands. Additional commands can be added to PBot through PBot has several useful core built-in commands. Additional commands can be added to PBot through
Factoids and Plugins. [Factoids](#factoids) and [Plugins](#plugins).
For more information, see the [Commands documentation.](doc/Commands.md)
### Advanced interpreter ### Advanced interpreter
@ -125,13 +123,13 @@ command-piping, `/code` invocation, and more!
PBot factoids include these advanced features: PBot factoids include these advanced features:
* metadata (e.g. owner, times used, last used date, locked, etc) * [undo/redo history](doc/Factoids.md#factundo)
* advanced argument processing (indexing, splicing, etc) * [changelog history](doc/Factoids.md#factlog)
* special commands: `/say`, `/me`, `/msg`, `/code`, etc * [advanced `$variable` interpolation (`$var:lc` to lowercase contents, `$var:ucfirst` to uppercase first letter, etc)](doc/Factoids.md#expansion-modifiers)
* advanced `$variable` interpolation (`$var:lc` to lowercase contents, `$var:ucfirst` to uppercase first letter, etc) * [factoid-based variable lists (e.g., add a factoid `colors` containing "red green blue" and then `!echo $colors` will randomly pick one)](doc/Factoids.md#list-variables)
* factoid-based variable lists (e.g., add a factoid `colors` containing "red green blue" and then `!echo $colors` will randomly pick one) * [advanced argument processing (indexing, splicing, etc)](doc/Factoids.md#special-variables-1)
* changelog history * [metadata (e.g. owner, times used, last used date, locked, etc)](doc/Factoids.md#factoid-metadata)
* undo/redo history * [special commands: `/say`, `/me`, `/msg`, `/code`, etc](doc/Factoids.md#special-commands)
* and much, much more! * and much, much more!
For more information, see the [Factoids documentation](doc/Factoids.md). For more information, see the [Factoids documentation](doc/Factoids.md).
@ -212,6 +210,10 @@ And then set its `type` to `module`:
!factset global qalc type module !factset global qalc type module
Alternatively you can simply use the [`load`](doc/Admin.md#load) command.
!load qalc qalc.sh
Now you have a `qalc` calculator in PBot! Now you have a `qalc` calculator in PBot!
<pragma-> !qalc 2 * 2 <pragma-> !qalc 2 * 2
@ -316,14 +318,11 @@ These settings can easily be configured via several methods:
For more information, see the [Registry documentation.](doc/Registry.md) For more information, see the [Registry documentation.](doc/Registry.md)
Documentation ## Documentation
-------------
See the [PBot documentation](doc) for more information. See the [PBot documentation](doc) for more information.
Support ## Support
-------
For questions and support, feel free to join the `#pbot2` channel on the [Freenode](https://freenode.net/kb/answer/chat) IRC network ([Web Chat](https://webchat.freenode.net/#pbot2)). For questions and support, feel free to join the `#pbot2` channel on the [Freenode](https://freenode.net/kb/answer/chat) IRC network ([Web Chat](https://webchat.freenode.net/#pbot2)).
License ## License
-------
PBot is licensed under the [Mozilla Public License, version 2](https://www.mozilla.org/en-US/MPL/2.0/). PBot is licensed under the [Mozilla Public License, version 2](https://www.mozilla.org/en-US/MPL/2.0/).