GitHub
/
pbot
mirror of https://github.com/pragma-/pbot.git
3
0
Fork 0
Code Issues Projects Releases Wiki Activity

doc/README.md: update TOC

This commit is contained in:
Pragmatic Software 2020-02-04 02:32:29 -08:00
parent 1d68cc7ae9
commit e68df00704
1 changed files with 65 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

65
doc/README.md
View File

@ -8,12 +8,19 @@
* [Installing Perl](QuickStart.md#installing-perl)
* [Installing CPAN modules](QuickStart.md#installing-cpan-modules)
* [Installing PBot](QuickStart.md#installing-pbot)
* [git (recommended)](QuickStart.md#git-recommended)
* [Download zip archive](QuickStart.md#download-zip-archive)
* [Initial Setup](QuickStart.md#initial-setup)
* [Clone data-directory](QuickStart.md#clone-data-directory)
* [Configuration](QuickStart.md#configuration)
* [Recommended settings for IRC Networks](QuickStart.md#recommended-settings-for-irc-networks)
* [Starting PBot](QuickStart.md#starting-pbot)
* [Usage](QuickStart.md#usage)
* [Overriding directories](QuickStart.md#overriding-directories)
* [Overriding registry](QuickStart.md#overriding-registry)
* [First-time start-up](QuickStart.md#first-time-start-up)
* [Using default Freenode settings](QuickStart.md#using-default-freenode-settings)
* [Using custom settings](QuickStart.md#using-custom-settings)
* [Regular start-up](QuickStart.md#regular-start-up)
* [Additional configuration](QuickStart.md#additional-configuration)
* [Creating your bot owner admin account](QuickStart.md#creating-your-bot-owner-admin-account)
@ -35,7 +42,11 @@
* [Inline invocation](Commands.md#inline-invocation)
* [Types of commands](Commands.md#types-of-commands)
* [Built-in commands](Commands.md#built-in-commands)
* [Creating new built-in commands](Commands.md#creating-new-built-in-commands)
* [Plugins](Commands.md#plugins)
* [Factoids](Commands.md#factoids)
* [Code Factoids](Commands.md#code-factoids)
* [Modules](Commands.md#modules)
* [Commands documented here](Commands.md#commands-documented-here)
* [version](Commands.md#version)
* [help](Commands.md#help)
@ -44,6 +55,21 @@
* [date](Commands.md#date)
* [weather](Commands.md#weather)
* [Commands documented elsewhere](Commands.md#commands-documented-elsewhere)
* [Administrative commands](Commands.md#administrative-commands)
* [Logging in and out of PBot](Commands.md#logging-in-and-out-of-pbot)
* [User management commands](Commands.md#user-management-commands)
* [Channel management commands](Commands.md#channel-management-commands)
* [Module management commands](Commands.md#module-management-commands)
* [Plugin management commands](Commands.md#plugin-management-commands)
* [Command metadata](Commands.md#command-metadata)
* [Registry commands](Commands.md#registry-commands)
* [Miscellaneous admin commands](Commands.md#miscellaneous-admin-commands)
* [Factoid commands](Commands.md#factoid-commands)
* [Adding/removing factoids](Commands.md#addingremoving-factoids)
* [Displaying factoids](Commands.md#displaying-factoids)
* [Editing factoids](Commands.md#editing-factoids)
* [Factoid metadata](Commands.md#factoid-metadata)
* [Information about factoids](Commands.md#information-about-factoids)
<!-- md-toc-end -->
<!-- md-toc-begin -->
* [Administrative](Admin.md#administrative)
@ -55,9 +81,15 @@
* [userdel](Admin.md#userdel)
* [userset](Admin.md#userset)
* [userunset](Admin.md#userunset)
* [User metadata list](Admin.md#user-metadata-list)
* [Listing users](Admin.md#listing-users)
* [User capabilities](Admin.md#user-capabilities)
* [cap](Admin.md#cap)
* [Listing capabilities](Admin.md#listing-capabilities)
* [Grouping capabilities](Admin.md#grouping-capabilities)
* [Giving capabilities to users](Admin.md#giving-capabilities-to-users)
* [Checking user capabilities](Admin.md#checking-user-capabilities)
* [User capabilities list](Admin.md#user-capabilities-list)
* [Channel management commands](Admin.md#channel-management-commands)
* [join](Admin.md#join)
* [part](Admin.md#part)
@ -66,6 +98,7 @@
* [chanset](Admin.md#chanset)
* [chanunset](Admin.md#chanunset)
* [chanlist](Admin.md#chanlist)
* [Channel metadata list](Admin.md#channel-metadata-list)
* [ignore](Admin.md#ignore)
* [unignore](Admin.md#unignore)
* [whitelist](Admin.md#whitelist)
@ -108,6 +141,15 @@
* [/call](Factoids.md#call)
* [/msg](Factoids.md#msg)
* [/code](Factoids.md#code)
* [Supported languages](Factoids.md#supported-languages)
* [Special variables](Factoids.md#special-variables)
* [testargs example](Factoids.md#testargs-example)
* [Setting a usage message](Factoids.md#setting-a-usage-message)
* [poll/vote example](Factoids.md#pollvote-example)
* [SpongeBob Mock meme example](Factoids.md#spongebob-mock-meme-example)
* [Using command-piping](Factoids.md#using-command-piping)
* [Improving SpongeBob Mock meme](Factoids.md#improving-spongebob-mock-meme)
* [Formatting and editing lengthy Code Factoids](Factoids.md#formatting-and-editing-lengthy-code-factoids)
* [Special variables](Factoids.md#special-variables-1)
* [$args](Factoids.md#args)
* [$arg[n]](Factoids.md#argn)
@ -174,6 +216,20 @@
* [Creating modules](Modules.md#creating-modules)
* [Documentation for built-in modules](Modules.md#documentation-for-built-in-modules)
* [cc](Modules.md#cc)
* [Usage](Modules.md#usage)
* [Supported Languages](Modules.md#supported-languages)
* [Default Language](Modules.md#default-language)
* [Disallowed system calls](Modules.md#disallowed-system-calls)
* [Program termination with no output](Modules.md#program-termination-with-no-output)
* [Abnormal program termination](Modules.md#abnormal-program-termination)
* [C and C++ Functionality](Modules.md#c-and-c-functionality)
* [Using the preprocessor](Modules.md#using-the-preprocessor)
* [main() Function Unnecessary](Modules.md#main-function-unnecessary)
* [Embedding Newlines](Modules.md#embedding-newlines)
* [Printing in binary/base2](Modules.md#printing-in-binarybase2)
* [Using the GDB debugger](Modules.md#using-the-gdb-debugger)
* [Interactive Editing](Modules.md#interactive-editing)
* [Some Examples](Modules.md#some-examples)
* [english](Modules.md#english)
* [expand](Modules.md#expand)
* [prec](Modules.md#prec)
@ -181,6 +237,15 @@
* [faq](Modules.md#faq)
* [cfact](Modules.md#cfact)
* [cjeopardy](Modules.md#cjeopardy)
* [hint](Modules.md#hint)
* [what](Modules.md#what)
* [w](Modules.md#w)
* [filter](Modules.md#filter)
* [score](Modules.md#score)
* [rank](Modules.md#rank)
* [reset](Modules.md#reset)
* [qstats](Modules.md#qstats)
* [qshow](Modules.md#qshow)
* [c99std](Modules.md#c99std)
* [c11std](Modules.md#c11std)
* [man](Modules.md#man)