mirror of
https://github.com/pragma-/pbot.git
synced 2024-11-22 11:59:43 +01:00
doc/README.md: rearrange sections
This commit is contained in:
parent
24450aa4af
commit
487fdd7799
116
doc/README.md
116
doc/README.md
@ -2,6 +2,35 @@
|
|||||||
|
|
||||||
## Table of Contents
|
## Table of Contents
|
||||||
|
|
||||||
|
<!-- md-toc-begin -->
|
||||||
|
* [QuickStart](QuickStart.md#quickstart)
|
||||||
|
* [Installation](QuickStart.md#installation)
|
||||||
|
* [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)
|
||||||
|
* [First-time Configuration](QuickStart.md#first-time-configuration)
|
||||||
|
* [Clone data-directory](QuickStart.md#clone-data-directory)
|
||||||
|
* [Quick-start command](QuickStart.md#quick-start-command)
|
||||||
|
* [Edit Registry](QuickStart.md#edit-registry)
|
||||||
|
* [Recommended settings for IRC Networks](QuickStart.md#recommended-settings-for-irc-networks)
|
||||||
|
* [Freenode](QuickStart.md#freenode)
|
||||||
|
* [IRCnet](QuickStart.md#ircnet)
|
||||||
|
* [Other networks](QuickStart.md#other-networks)
|
||||||
|
* [Starting PBot](QuickStart.md#starting-pbot)
|
||||||
|
* [Usage](QuickStart.md#usage)
|
||||||
|
* [Overriding directories](QuickStart.md#overriding-directories)
|
||||||
|
* [Overriding registry](QuickStart.md#overriding-registry)
|
||||||
|
* [Additional Configuration](QuickStart.md#additional-configuration)
|
||||||
|
* [Adding Channels](QuickStart.md#adding-channels)
|
||||||
|
* [Adding Admins](QuickStart.md#adding-admins)
|
||||||
|
* [Loading Plugins](QuickStart.md#loading-plugins)
|
||||||
|
* [Further Reading](QuickStart.md#further-reading)
|
||||||
|
* [Commands](QuickStart.md#commands)
|
||||||
|
* [Factoids](QuickStart.md#factoids)
|
||||||
|
* [Modules](QuickStart.md#modules)
|
||||||
|
<!-- md-toc-end -->
|
||||||
<!-- md-toc-begin -->
|
<!-- md-toc-begin -->
|
||||||
* [Administrative](Admin.md#administrative)
|
* [Administrative](Admin.md#administrative)
|
||||||
* [Logging in and out](Admin.md#logging-in-and-out)
|
* [Logging in and out](Admin.md#logging-in-and-out)
|
||||||
@ -53,17 +82,6 @@
|
|||||||
* [die](Admin.md#die)
|
* [die](Admin.md#die)
|
||||||
<!-- md-toc-end -->
|
<!-- md-toc-end -->
|
||||||
<!-- md-toc-begin -->
|
<!-- md-toc-begin -->
|
||||||
* [Anti-Abuse](AntiAbuse.md#anti-abuse)
|
|
||||||
* [Flood control](AntiAbuse.md#flood-control)
|
|
||||||
* [Message flood](AntiAbuse.md#message-flood)
|
|
||||||
* [Join flood](AntiAbuse.md#join-flood)
|
|
||||||
* [Enter key abuse](AntiAbuse.md#enter-key-abuse)
|
|
||||||
* [Nick flood](AntiAbuse.md#nick-flood)
|
|
||||||
* [Anti-away/Nick-control](AntiAbuse.md#anti-awaynick-control)
|
|
||||||
* [Anti-auto-rejoin control](AntiAbuse.md#anti-auto-rejoin-control)
|
|
||||||
* [Opping/Deopping](AntiAbuse.md#oppingdeopping)
|
|
||||||
<!-- md-toc-end -->
|
|
||||||
<!-- md-toc-begin -->
|
|
||||||
* [Factoids](Factoids.md#factoids)
|
* [Factoids](Factoids.md#factoids)
|
||||||
* [About](Factoids.md#about)
|
* [About](Factoids.md#about)
|
||||||
* [Channel namespaces](Factoids.md#channel-namespaces)
|
* [Channel namespaces](Factoids.md#channel-namespaces)
|
||||||
@ -127,6 +145,26 @@
|
|||||||
* [top20](Factoids.md#top20)
|
* [top20](Factoids.md#top20)
|
||||||
<!-- md-toc-end -->
|
<!-- md-toc-end -->
|
||||||
<!-- md-toc-begin -->
|
<!-- md-toc-begin -->
|
||||||
|
* [Registry](Registry.md#registry)
|
||||||
|
* [About](Registry.md#about)
|
||||||
|
* [Types of values](Registry.md#types-of-values)
|
||||||
|
* [Creating array values](Registry.md#creating-array-values)
|
||||||
|
* [Overriding Registry values per-channel](Registry.md#overriding-registry-values-per-channel)
|
||||||
|
* [Overriding Registry values via command-line](Registry.md#overriding-registry-values-via-command-line)
|
||||||
|
* [Registry commands](Registry.md#registry-commands)
|
||||||
|
* [regset](Registry.md#regset)
|
||||||
|
* [regunset](Registry.md#regunset)
|
||||||
|
* [regchange](Registry.md#regchange)
|
||||||
|
* [regshow](Registry.md#regshow)
|
||||||
|
* [regfind](Registry.md#regfind)
|
||||||
|
* [regsetmeta](Registry.md#regsetmeta)
|
||||||
|
* [regunsetmeta](Registry.md#regunsetmeta)
|
||||||
|
* [Editing Registry file](Registry.md#editing-registry-file)
|
||||||
|
* [Metadata list](Registry.md#metadata-list)
|
||||||
|
* [List of known Registry items](Registry.md#list-of-known-registry-items)
|
||||||
|
* [Channel-specific Registry items](Registry.md#channel-specific-registry-items)
|
||||||
|
<!-- md-toc-end -->
|
||||||
|
<!-- md-toc-begin -->
|
||||||
* [Modules](Modules.md#modules)
|
* [Modules](Modules.md#modules)
|
||||||
* [About](Modules.md#about)
|
* [About](Modules.md#about)
|
||||||
* [Creating modules](Modules.md#creating-modules)
|
* [Creating modules](Modules.md#creating-modules)
|
||||||
@ -202,35 +240,6 @@
|
|||||||
* [quote](Modules.md#quote)
|
* [quote](Modules.md#quote)
|
||||||
<!-- md-toc-end -->
|
<!-- md-toc-end -->
|
||||||
<!-- md-toc-begin -->
|
<!-- md-toc-begin -->
|
||||||
* [QuickStart](QuickStart.md#quickstart)
|
|
||||||
* [Installation](QuickStart.md#installation)
|
|
||||||
* [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)
|
|
||||||
* [First-time Configuration](QuickStart.md#first-time-configuration)
|
|
||||||
* [Clone data-directory](QuickStart.md#clone-data-directory)
|
|
||||||
* [Quick-start command](QuickStart.md#quick-start-command)
|
|
||||||
* [Edit Registry](QuickStart.md#edit-registry)
|
|
||||||
* [Recommended settings for IRC Networks](QuickStart.md#recommended-settings-for-irc-networks)
|
|
||||||
* [Freenode](QuickStart.md#freenode)
|
|
||||||
* [IRCnet](QuickStart.md#ircnet)
|
|
||||||
* [Other networks](QuickStart.md#other-networks)
|
|
||||||
* [Starting PBot](QuickStart.md#starting-pbot)
|
|
||||||
* [Usage](QuickStart.md#usage)
|
|
||||||
* [Overriding directories](QuickStart.md#overriding-directories)
|
|
||||||
* [Overriding registry](QuickStart.md#overriding-registry)
|
|
||||||
* [Additional Configuration](QuickStart.md#additional-configuration)
|
|
||||||
* [Adding Channels](QuickStart.md#adding-channels)
|
|
||||||
* [Adding Admins](QuickStart.md#adding-admins)
|
|
||||||
* [Loading Plugins](QuickStart.md#loading-plugins)
|
|
||||||
* [Further Reading](QuickStart.md#further-reading)
|
|
||||||
* [Commands](QuickStart.md#commands)
|
|
||||||
* [Factoids](QuickStart.md#factoids)
|
|
||||||
* [Modules](QuickStart.md#modules)
|
|
||||||
<!-- md-toc-end -->
|
|
||||||
<!-- md-toc-begin -->
|
|
||||||
* [Quotegrabs](Quotegrabs.md#quotegrabs)
|
* [Quotegrabs](Quotegrabs.md#quotegrabs)
|
||||||
* [About](Quotegrabs.md#about)
|
* [About](Quotegrabs.md#about)
|
||||||
* [Commands](Quotegrabs.md#commands)
|
* [Commands](Quotegrabs.md#commands)
|
||||||
@ -240,24 +249,15 @@
|
|||||||
* [delq](Quotegrabs.md#delq)
|
* [delq](Quotegrabs.md#delq)
|
||||||
<!-- md-toc-end -->
|
<!-- md-toc-end -->
|
||||||
<!-- md-toc-begin -->
|
<!-- md-toc-begin -->
|
||||||
* [Registry](Registry.md#registry)
|
* [Anti-Abuse](AntiAbuse.md#anti-abuse)
|
||||||
* [About](Registry.md#about)
|
* [Flood control](AntiAbuse.md#flood-control)
|
||||||
* [Types of values](Registry.md#types-of-values)
|
* [Message flood](AntiAbuse.md#message-flood)
|
||||||
* [Creating array values](Registry.md#creating-array-values)
|
* [Join flood](AntiAbuse.md#join-flood)
|
||||||
* [Overriding Registry values per-channel](Registry.md#overriding-registry-values-per-channel)
|
* [Enter key abuse](AntiAbuse.md#enter-key-abuse)
|
||||||
* [Overriding Registry values via command-line](Registry.md#overriding-registry-values-via-command-line)
|
* [Nick flood](AntiAbuse.md#nick-flood)
|
||||||
* [Registry commands](Registry.md#registry-commands)
|
* [Anti-away/Nick-control](AntiAbuse.md#anti-awaynick-control)
|
||||||
* [regset](Registry.md#regset)
|
* [Anti-auto-rejoin control](AntiAbuse.md#anti-auto-rejoin-control)
|
||||||
* [regunset](Registry.md#regunset)
|
* [Opping/Deopping](AntiAbuse.md#oppingdeopping)
|
||||||
* [regchange](Registry.md#regchange)
|
|
||||||
* [regshow](Registry.md#regshow)
|
|
||||||
* [regfind](Registry.md#regfind)
|
|
||||||
* [regsetmeta](Registry.md#regsetmeta)
|
|
||||||
* [regunsetmeta](Registry.md#regunsetmeta)
|
|
||||||
* [Editing Registry file](Registry.md#editing-registry-file)
|
|
||||||
* [Metadata list](Registry.md#metadata-list)
|
|
||||||
* [List of known Registry items](Registry.md#list-of-known-registry-items)
|
|
||||||
* [Channel-specific Registry items](Registry.md#channel-specific-registry-items)
|
|
||||||
<!-- md-toc-end -->
|
<!-- md-toc-end -->
|
||||||
<!-- md-toc-begin -->
|
<!-- md-toc-begin -->
|
||||||
* [Virtual Machine](VirtualMachine.md#virtual-machine)
|
* [Virtual Machine](VirtualMachine.md#virtual-machine)
|
||||||
|
Loading…
Reference in New Issue
Block a user