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

QuickStart: improvements

Browse Source
This commit is contained in:
Pragmatic Software 2020-01-02 21:44:34 -08:00
parent 47f0876c9f
commit f0cbcd9994
1 changed files with 15 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
doc/QuickStart.md
View File

@ -2,7 +2,7 @@ QuickStart
========== ==========
<!-- md-toc-begin --> <!-- md-toc-begin -->
* [Installing](#installing) * [Installation](#installing)
* [Installing Perl](#installing-perl) * [Installing Perl](#installing-perl)
* [Installing CPAN modules](#installing-cpan-modules) * [Installing CPAN modules](#installing-cpan-modules)
* [Installing PBot](#installing-pbot) * [Installing PBot](#installing-pbot)
@ -29,8 +29,8 @@ QuickStart
* [Modules](#modules) * [Modules](#modules)
<!-- md-toc-end --> <!-- md-toc-end -->
Installing Installation
---------- ------------
### Installing Perl ### Installing Perl
@ -40,8 +40,9 @@ system's documentation to install it.
### Installing CPAN modules ### Installing CPAN modules
PBot has many features; some of these depend on Perl modules written by others. Some of PBot's features depend on the availability of Perl modules written by
This list can be found in the `MODULES` file in the root directory of this source. third parties. To use such PBot features, the modules listed in the [`MODULES`](https://github.com/pragma-/pbot/blob/master/MODULES)
file need to be installed.
The modules may be installed with a simple command: The modules may be installed with a simple command:
@ -56,8 +57,9 @@ expected.
#### git (recommended) #### git (recommended)
The recommended way to install PBot is with `git`. This will allow you easily update to The recommended way to install PBot is with `git`. This will allow you easily update to
the latest version of PBot via the `git pull` command. Also, if you become interested in the latest version of PBot via the git update process by issuing the `git pull` command.
contributing improvements to PBot, you will be able to submit them through `git`. Also, if you become interested in contributing improvements to PBot, you will be able to
submit them through `git`.
The command to install with `git` is: The command to install with `git` is:
@ -75,12 +77,12 @@ After git-cloning (or unpacking the ZIP archive) you should have a directory nam
Name | Description Name | Description
--- | --- --- | ---
`PBot/` | PBot source tree [`PBot/`](https://github.com/pragma-/pbot/tree/master/PBot) | PBot source tree
`Plugins/` | Dynamically loadable internal plugins [`Plugins/`](https://github.com/pragma-/pbot/tree/master/Plugins) | Dynamically loadable internal plugins
`modules/` | External command-line executables invokable by PBot commands [`modules/`](https://github.com/pragma-/pbot/tree/master/modules) | External command-line executables invokable by PBot commands
`data/` | Default data-directory [`data/`](https://github.com/pragma-/pbot/tree/master/data) | Default data-directory
`doc/` | Helpful documentation [`doc/`](https://github.com/pragma-/pbot/tree/master/doc) | Helpful documentation
`pbot` | executable used to launch PBot [`pbot`](https://github.com/pragma-/pbot/blob/master/pbot) | executable used to launch PBot
You may create a symbolic-link to the `pbot` executable in `$HOME/bin/` or even You may create a symbolic-link to the `pbot` executable in `$HOME/bin/` or even
in `/usr/local/bin/`. in `/usr/local/bin/`.