pidgin/plugins-ansible

Add a README.md

22 months ago, Gary Kramlich
f9e78a668ea2
Parents 72979ff27735
Children 4bca9901be27
Add a README.md
  • +35 -0
    README.md
  • --- /dev/null Thu Jan 01 00:00:00 1970 +0000
    +++ b/README.md Sat Jul 09 01:01:07 2022 -0500
    @@ -0,0 +1,35 @@
    +# Plugins Archive
    +
    +This repoistory contains an Ansible playbook that will use `plugins.json` from
    +[pidgin.im](https://pidgin.im/plugins) to download every known plugin.
    +
    +The primary use case for this is for archival purposes but it's also used to
    +look for issues with the list itself. It is also useful as you can simply grep
    +the source code of all plugins at once.
    +
    +## Prerequisites
    +
    +You will need about 1.3GB of disk space as well as the following programs
    +installed for this run properly:
    +
    +* bzip2
    +* bzr
    +* cvs
    +* git
    +* gzip
    +* mercurial
    +* subversion
    +* tar
    +* unzip
    +
    +## Running
    +
    +Running the playbook can be done with the following command:
    +
    +```
    +ansible-playbook plugins.yml
    +```
    +
    +This will take a bit to run based on your internet connection and the external
    +hosts.
    +