Browse Source

Documentation for installation process

tags/v0.1^2
Ben Kurtovic 12 years ago
parent
commit
d8a7867518
1 changed files with 34 additions and 3 deletions
  1. +34
    -3
      README.md

+ 34
- 3
README.md View File

@@ -14,7 +14,7 @@ was carried out in May, and the bot has been running consistently ever since
[several ongoing tasks](http://en.wikipedia.org/wiki/User:EarwigBot#Tasks), [several ongoing tasks](http://en.wikipedia.org/wiki/User:EarwigBot#Tasks),
ranging from statistics generation to category cleanup, and on-demand tasks ranging from statistics generation to category cleanup, and on-demand tasks
such as WikiProject template tagging. Since it started running, the bot has such as WikiProject template tagging. Since it started running, the bot has
made over 45,000 edits.
made over 50,000 edits.


A project to rewrite it from scratch began in early April 2011, thus moving A project to rewrite it from scratch began in early April 2011, thus moving
away from the Pywikipedia framework and allowing for less overall code, better away from the Pywikipedia framework and allowing for less overall code, better
@@ -22,9 +22,40 @@ integration between bot parts, and easier maintenance.


# Installation # Installation


## From stable
This package contains the core `earwigbot`, abstracted enough that it should be
usable and customizable by anyone running a bot on a MediaWiki site. Since it's
component-based, the IRC components can be disabled if desired. IRC commands
and bot tasks specific to
[my instance of EarwigBot](http://en.wikipedia.org/wiki/User:EarwigBot) are
available from the package
[earwigbot-plugins](https://github.com/earwig/earwigbot-plugins).


## From development
## Latest release (v0.1)

EarwigBot is available from the [Python Package Index](http://pypi.python.org),
so you can install the latest release with `pip install earwigbot`
([get pip](http://pypi.python.org/pypi/pip)).

You can also install it from source directly:

curl -Lo earwigbot.tgz "https://github.com/earwig/earwigbot/tarball/v0.1"
tar -xf earwigbot.tgz
cd earwig-earwigbot-*
python setup.py install # may require root, or use --user switch to install locally
cd ..
rm -r earwigbot.tgz earwig-earwigbot-*

## Development version

You can install the development version of the bot from `git`, probably on the
`develop` branch which contains (usually) working code. `master` contains the
latest release. EarwigBot uses
[git flow](http://nvie.com/posts/a-successful-git-branching-model/), so you're
free to browse by tags or by new features (`feature/*` branches).

git clone git://github.com/earwig/earwigbot.git earwigbot
cd earwigbot
python setup.py develop # may require root, or use --user switch to install locally


# Setup # Setup




Loading…
Cancel
Save