| 1 | = Plumage = |
| 2 | |
| 3 | Plumage is the Parrot VM module ecosystem. It includes tools to search the ecosystem, |
| 4 | browse the module metadata, install modules, and so forth. |
| 5 | |
| 6 | The ecosystem currently includes various compilers targetting Parrot VM, libraries, |
| 7 | language bindings and more. |
| 8 | |
| 9 | = Getting Plumage = |
| 10 | |
| 11 | The Plumage repo is located on Github (https://github.com/parrot/plumage). You can either |
| 12 | download a tarball or simply clone the repository with `git clone git://github.com/parrot/plumage.git`. |
| 13 | To build plumage, execute |
| 14 | {{{ |
| 15 | parrot setup.pir build |
| 16 | parrot setup.pir test # optional, to see if everything is working properly |
| 17 | parrot setur.pir install |
| 18 | }}} |
| 19 | |
| 20 | You may need a root access in the last step, depending on where your Parrot is located. |
| 21 | Plumage will install itself into the Parrot directory tree. After that, you're ready to go. |
| 22 | |
| 23 | = Usage = |
| 24 | |
| 25 | To show a list of projects, use `plumage projects`. After choosing the one you want to install, simply |
| 26 | run `plumage install <project>`. This will build, test and install the desired project into the Parrot |
| 27 | directory tree. |
| 28 | |
| 29 | For more usage information run `plumage usage` |