Changes between Version 2 and Version 3 of GettingStartedWithPlumage

Show
Ignore:
Timestamp:
07/19/11 03:38:24 (3 years ago)
Author:
soh_cah_toa
Comment:

Added a few examples, fixed some grammar mistakes, and further elaborated in several paragraphs.

Legend:

Unmodified
Added
Removed
Modified
  • GettingStartedWithPlumage

    v2 v3  
    11= Plumage = 
    22 
    3 Plumage is the Parrot VM module ecosystem. It includes tools to search the ecosystem, 
     3Plumage is a package manager for the Parrot VM module ecosystem. It includes tools to search the ecosystem, 
    44browse the module metadata, install modules, and so forth. 
    55 
    6 The ecosystem currently includes various compilers targetting Parrot VM, libraries, 
    7 language bindings and more. 
     6The ecosystem currently includes various compilers targeting Parrot, libraries, 
     7language bindings, and more. 
    88 
    99= Getting Plumage = 
    1010 
    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 
     11The Plumage repository is hosted on [https://github.com/parrot/plumage Github]. You can obtain a copy of the 
     12source code by running `git clone git://github.com/parrot/plumage.git`. 
     13To install Plumage, run the following sequence of commands: 
     14 
    1415{{{ 
    15 parrot setup.pir build 
    16 parrot setup.pir test # optional, to see if everything is working properly 
    17 parrot setur.pir install 
     16parrot setup.pir build      # Builds executable 
     17parrot setup.pir test       # Optional, runs test suite 
     18parrot setur.pir install    # Installs executable 
    1819}}} 
    1920 
    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. 
     21If you received an error message in the last step that's similar to: 
    2222 
    23 Note: on Windows, since Parrot 3.0.0, plumage is shipped with Parrot binaries [http://sourceforge.net/projects/parrotwin32/]. 
     23{{{ 
     24Can't mkdir '/usr/local/lib/parrot/[version]/library/Plumage' (Permission denied) 
     25}}} 
     26 
     27Where `[version]` is the version of Parrot installed, you need root access to complete the installation. Try prefixing the last 
     28command with `sudo` or `su -c`. 
     29 
     30Plumage is installed to the same directory that Parrot was installed to. This is `/usr/local/bin` by default. If you want to change this, 
     31you need to re-install Parrot. Use the `--prefix` switch when running `Configure.pl`. For example,  
     32`perl Configure.pl --prefix=/foo/bar/baz`. 
     33 
     34Once the above steps have been completed, you can then begin using Plumage. 
     35 
     36''NOTE FOR WINDOWS USERS'': Since Parrot 3.0.0, Plumage is shipped with the Parrot binaries at [http://sourceforge.net/projects/parrotwin32/]. 
    2437 
    2538= Usage = 
    2639 
    27 To show a list of projects, use `plumage projects`. After choosing the one you want to install, simply 
    28 run `plumage install <project>`. This will build, test and install the desired project into the Parrot 
     40To show the list of projects that are in the ecosystem, run `plumage projects`. After choosing the one you want to install, simply 
     41run `plumage install <project>`. This will build, test, and install the desired project into the Parrot 
    2942directory tree. 
    3043 
    31 For more usage information run `plumage usage` 
     44For example, if you want to install `partcl` (an implementation of Tcl), run: 
     45 
     46{{{ 
     47plumage install partcl 
     48}}} 
     49 
     50Just like when installing Plumage, root access may be required depending on where the default installation directory is. If 
     51that is the case, you will be prompted to enter your password. 
     52 
     53If you decide that you no longer need a particular package, you can remove it with the `uninstall` command. Using `partcl` as an example again, run: 
     54 
     55{{{ 
     56plumage uninstall partcl 
     57}}} 
     58 
     59Plumage is able to resolve package dependencies. If package `Foo` depends on package `Bar`, installing `Foo` will also silently install `Bar`. 
     60 
     61For more usage information, run `plumage usage`.