Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 204 lines (123 sloc) 6.267 kb
e578b78 Alvis Yardley Added a DESCRIPTION. NOTE: This document 'should' be renamed to 'develop...
ayardley authored
1 # Copyright (C) 2001-2012, Parrot Foundation.
3ffdf1e #25248
Leopold Toetsch authored
2
9d8cce4 a bit more tidying up
Michael Scott authored
3 =head1 NAME
3ffdf1e #25248
Leopold Toetsch authored
4
9d8cce4 a bit more tidying up
Michael Scott authored
5 docs/gettingstarted.pod - Parrot Developer FAQ
3ffdf1e #25248
Leopold Toetsch authored
6
e578b78 Alvis Yardley Added a DESCRIPTION. NOTE: This document 'should' be renamed to 'develop...
ayardley authored
7 =head1 DESCRIPTION
8
9 This document is the Developer FAQ for Parrot.
10
3ffdf1e #25248
Leopold Toetsch authored
11 =head1 DEVELOPER FAQ
12
13 =head2 I'm interested in helping out. What should I do?
14
05a7e7b Bernhard Schmalhofer This patch is huge because of all the whitespace reformatting. This was
bschmalhofer authored
15 You're already on the right track. This FAQ should help you find everything you
16 need to become an active member of the Parrot community. Just look through the
17 questions below and read the ones that apply to you.
3ffdf1e #25248
Leopold Toetsch authored
18
bc27b0e Bernhard Schmalhofer [doc] Add link to ParrotDeveloperGuide
bschmalhofer authored
19 More current information is also available at
20 L<https://trac.parrot.org/parrot/wiki/NewParrotDeveloperGuide>.
21
3ffdf1e #25248
Leopold Toetsch authored
22 =head2 Where can I get Parrot?
23
24 =over 4
25
26 =item *
27
e13a157 Duke Leto [docs] Update gettingstarted.pod
leto authored
28 There is a web interface to the git repository, in case you just want to
05a7e7b Bernhard Schmalhofer This patch is huge because of all the whitespace reformatting. This was
bschmalhofer authored
29 browse the source.
3ffdf1e #25248
Leopold Toetsch authored
30
e13a157 Duke Leto [docs] Update gettingstarted.pod
leto authored
31 L<http://github.com/parrot/parrot>
3ffdf1e #25248
Leopold Toetsch authored
32
33 =item *
34
2400661 allisonrandal [cage] Updating getting started guide for currently supported ways of ge...
allisonrandal authored
35 The easiest solution is to grab the latest monthly development release. You can
36 find it here:
3ffdf1e #25248
Leopold Toetsch authored
37
2400661 allisonrandal [cage] Updating getting started guide for currently supported ways of ge...
allisonrandal authored
38 L<http://www.parrot.org/release/current>
3ffdf1e #25248
Leopold Toetsch authored
39
40 =item *
41
e13a157 Duke Leto [docs] Update gettingstarted.pod
leto authored
42 An even better option is to use git, which gets you the very latest copy of the
2400661 allisonrandal [cage] Updating getting started guide for currently supported ways of ge...
allisonrandal authored
43 Parrot distribution. The procedure for this is:
3ffdf1e #25248
Leopold Toetsch authored
44
e13a157 Duke Leto [docs] Update gettingstarted.pod
leto authored
45 git clone http://github.com/parrot/parrot
0c7f281 Will Coleda #56102: Fwd: [PATCH] add git-svn instructions to gettingstarted.pod
coke authored
46
3ffdf1e #25248
Leopold Toetsch authored
47 =back
48
73ba72d [perl #36057] [PATCH] Fix some typos - 5
Leopold Toetsch authored
49 The above instructions are also on the Parrot website:
3ffdf1e #25248
Leopold Toetsch authored
50
1a290c7 Bernhard Schmalhofer [docs] s/parrotcode.org/parrot.org/
bschmalhofer authored
51 L<http://www.parrot.org/download>
3ffdf1e #25248
Leopold Toetsch authored
52
8c80f80 Update the getting started guide
Simon Glover authored
53 =head2 Now that I've got Parrot, what do I do?
3ffdf1e #25248
Leopold Toetsch authored
54
05a7e7b Bernhard Schmalhofer This patch is huge because of all the whitespace reformatting. This was
bschmalhofer authored
55 Now that you've downloaded Parrot, you probably want to try it out. All you
cefc7d7 Will Coleda RT# 42616 -
coke authored
56 need is Perl 5.8.0 or later, a C compiler (any ANSI C compliant compiler
05a7e7b Bernhard Schmalhofer This patch is huge because of all the whitespace reformatting. This was
bschmalhofer authored
57 should do - if you find one that doesn't work, please report it to us), and
8c80f80 Update the getting started guide
Simon Glover authored
58 some reasonable form of C<make>. To do this, follow these three easy steps.
3ffdf1e #25248
Leopold Toetsch authored
59
60 =over 4
61
62 =item 1
63
e13a157 Duke Leto [docs] Update gettingstarted.pod
leto authored
64 C<cd> to your parrot directory and run C<perl Configure.pl> to create the makefile
8c80f80 Update the getting started guide
Simon Glover authored
65 for your platform.
3ffdf1e #25248
Leopold Toetsch authored
66
67 =item 2
68
69 Run C<make> to compile everything and build parrot.
70
71 =item 3
72
ca610d6 Jerry Gay [docs] update to mailing list links, in preparation for turning off perl...
particle authored
73 Run C<make test> to run the test suite and verify that everything works on
8c80f80 Update the getting started guide
Simon Glover authored
74 your system.
3ffdf1e #25248
Leopold Toetsch authored
75
76 =back
77
05a7e7b Bernhard Schmalhofer This patch is huge because of all the whitespace reformatting. This was
bschmalhofer authored
78
79
3ffdf1e #25248
Leopold Toetsch authored
80 =head2 Where's the Parrot documentation?
81
05a7e7b Bernhard Schmalhofer This patch is huge because of all the whitespace reformatting. This was
bschmalhofer authored
82 Well, Parrot documentation is a great place to contribute, should you be
83 looking for something to do. Figure out which parts were confusing, and either
84 help us fix them, or let us know where we should fix them. Luckily, all of the
85 current Parrot documentation is included along with the Parrot distribution, in
86 the /docs/ directory.
3ffdf1e #25248
Leopold Toetsch authored
87
f928e3c Alvis Yardley Removed the word 'experimental' and the implication that our html docs a...
ayardley authored
88 We also have auto-generated HTML documentation, which is available through
89 executing the following command in the Parrot distribution's root directory:
9d8cce4 a bit more tidying up
Michael Scott authored
90
b103d20 Bernhard Schmalhofer Update 'docs' WRT to the switch to subversion.
bschmalhofer authored
91 % make html
9d8cce4 a bit more tidying up
Michael Scott authored
92
f928e3c Alvis Yardley Removed the word 'experimental' and the implication that our html docs a...
ayardley authored
93 To view the HTML documentation, start with the F<docs/html/index.html> page.
9d8cce4 a bit more tidying up
Michael Scott authored
94
b71c965 Alvis Yardley Minor modification of some otherwise awkward language.
ayardley authored
95 We have several categories of documentation, each with a different purpose. It
96 will, probably, prove useful to you if you are aware of them I<before> you go
97 digging around in them. We strongly suggest you review
98 F</docs/pdds/pdd07_codingstd.pod> for guidance on how best to layout the
99 documentation. But for now, here's the executive summary:
3ffdf1e #25248
Leopold Toetsch authored
100
101 =over 4
102
103 =item * PDDs
104
05a7e7b Bernhard Schmalhofer This patch is huge because of all the whitespace reformatting. This was
bschmalhofer authored
105 Parrot Design Documents (PDDs) document the basic design of the Parrot
106 interpreter, with each PDD focusing on a particular topic, such as the design
107 of the garbage collector (PDD 09) or the object system (PDD 15). They can be
108 found in the F</docs/pdds> directory.
3ffdf1e #25248
Leopold Toetsch authored
109
05a7e7b Bernhard Schmalhofer This patch is huge because of all the whitespace reformatting. This was
bschmalhofer authored
110 NB: Some important areas are still missing PDDs; we're working to rectify that.
3ffdf1e #25248
Leopold Toetsch authored
111
112 =item * Developer files
113
05a7e7b Bernhard Schmalhofer This patch is huge because of all the whitespace reformatting. This was
bschmalhofer authored
114 These are files which correspond to a specific source file, and can be found in
115 F</docs/dev/>. A developer file contains documentation on all the
116 implementation decisions associated with the source file. (Note that this is in
117 contrast to PDDs, which describe design decisions). This is the place for
118 mini-essays on how to avoid overflows in unsigned arithmetic, or on the pros
119 and cons of differing hash algorithms, and why the current one was chosen, and
120 how it works.
8c80f80 Update the getting started guide
Simon Glover authored
121
955f01e Paul Cochrane [docs] References to developer files have now been updated to point to
paultcochrane authored
122 If you are coming to a particular source file for the first time, you should
123 be able to read the developer file and gain an immediate overview of what
124 the source file is for, the algorithms it implements, etc.
3ffdf1e #25248
Leopold Toetsch authored
125
955f01e Paul Cochrane [docs] References to developer files have now been updated to point to
paultcochrane authored
126 NB: We need more developer files too. Patches welcome!
3ffdf1e #25248
Leopold Toetsch authored
127
128 =item * Source file documentation
129
05a7e7b Bernhard Schmalhofer This patch is huge because of all the whitespace reformatting. This was
bschmalhofer authored
130 Each source file includes comments embedded in the document. Usually this means
131 function-level documentation that describes the purpose and intent of a
132 function, along with any other important information. For larger functions, it
133 will include additional documentation that explains the meaning of code, as
134 opposed to a verbatim translation of code.
3ffdf1e #25248
Leopold Toetsch authored
135
136 =back
137
138 =head2 Where can I find the main developer mailing list?
139
ac517aa Chip Salzenberg From: Chris Dolan <chris@chrisdolan.net>
chipdude authored
140 Most of the Parrot-related development discussion occurs on the
ca610d6 Jerry Gay [docs] update to mailing list links, in preparation for turning off perl...
particle authored
141 parrot-dev (previously known as parrot-porters and perl6-internals) mailing
142 list. There are a variety of interfaces to the list:
3ffdf1e #25248
Leopold Toetsch authored
143
144 =over 4
145
afc981d chromatic Fixed some POD formatting errors.
chromatic authored
146 =item * Developer Mailing List Interface (subscribing, unsubscribing, etc)
3ffdf1e #25248
Leopold Toetsch authored
147
ca610d6 Jerry Gay [docs] update to mailing list links, in preparation for turning off perl...
particle authored
148 L<http://lists.parrot.org/mailman/listinfo/parrot-dev>
3ffdf1e #25248
Leopold Toetsch authored
149
ac517aa Chip Salzenberg From: Chris Dolan <chris@chrisdolan.net>
chipdude authored
150 =item * Parrot NNTP Interface
3ffdf1e #25248
Leopold Toetsch authored
151
ca610d6 Jerry Gay [docs] update to mailing list links, in preparation for turning off perl...
particle authored
152 L<nntp://news.gmane.org/gmane.comp.compilers.parrot.devel>
3ffdf1e #25248
Leopold Toetsch authored
153
ca610d6 Jerry Gay [docs] update to mailing list links, in preparation for turning off perl...
particle authored
154 =item * Parrot Archives, RSS
3ffdf1e #25248
Leopold Toetsch authored
155
ca610d6 Jerry Gay [docs] update to mailing list links, in preparation for turning off perl...
particle authored
156 L<http://groups.google.com/group/parrot-dev> provides archives, search,
157 and RSS feeds.
3ffdf1e #25248
Leopold Toetsch authored
158
ca610d6 Jerry Gay [docs] update to mailing list links, in preparation for turning off perl...
particle authored
159 L<http://news.gmane.org/gmane.comp.compilers.parrot.devel>
3ffdf1e #25248
Leopold Toetsch authored
160
ca610d6 Jerry Gay [docs] update to mailing list links, in preparation for turning off perl...
particle authored
161 L<http://lists.parrot.org/pipermail/parrot-dev/>
3ffdf1e #25248
Leopold Toetsch authored
162
163 =back
164
fe1f244 James E Keenan Remove references to svn or svn.parrot.org. Replace with git references...
jkeenan authored
165 In addition, there is a mailing list which logs all commits to the Parrot Git
e43527c Will Coleda [docs]
coke authored
166 repository. If you're interested in Parrot development, you might find it very
1772034 Joshua Hoblitt reformat all Pod files under docs with podtidy except for docs/pdds
jhoblitt authored
167 helpful to subscribe and keep up on changes that people are making.
3ffdf1e #25248
Leopold Toetsch authored
168
169 =over 4
170
171 =item * Mailing List Interface (subscribing, unsubscribing, etc)
172
ca610d6 Jerry Gay [docs] update to mailing list links, in preparation for turning off perl...
particle authored
173 L<http://lists.parrot.org/mailman/listinfo/parrot-commits>
3ffdf1e #25248
Leopold Toetsch authored
174
e43527c Will Coleda [docs]
coke authored
175 =item * Commit List Archives, RSS
3ffdf1e #25248
Leopold Toetsch authored
176
ca610d6 Jerry Gay [docs] update to mailing list links, in preparation for turning off perl...
particle authored
177 L<http://lists.parrot.org/pipermail/parrot-commits/>
3ffdf1e #25248
Leopold Toetsch authored
178
179 =back
180
181
182 =head2 What other ways can I get in contact with the Parrot developers?
183
ea19c4e Jerry Gay #40793: [PATCH] outdated wiki & irc links in docs/gettingstarted.pod
particle authored
184 The mailing list is the main resource for Parrot development. However, there
185 is an IRC channel which you may find useful if your problem is better solved
186 with real-time discussion. Visit the channel #parrot on the IRC
5a52434 allisonrandal [cage] Update all references for irc.perl.org to irc.parrot.org.
allisonrandal authored
187 server L<irc.parrot.org>. Alternative IRC servers are
ea19c4e Jerry Gay #40793: [PATCH] outdated wiki & irc links in docs/gettingstarted.pod
particle authored
188 L<irc.rhizomatic.net> and L<irc.pobox.com>.
3ffdf1e #25248
Leopold Toetsch authored
189
190 =head2 I've developed a patch. What should I do with it?
191
de56d19 allisonrandal [cage] Updating some broken links in the gettingstarted guide.
allisonrandal authored
192 See F<docs/submissions.pod> for details.
3ffdf1e #25248
Leopold Toetsch authored
193
194 =head2 I've found a bug, what now?
195
de56d19 allisonrandal [cage] Updating some broken links in the gettingstarted guide.
allisonrandal authored
196 See F<docs/submissions.pod> for details.
3ffdf1e #25248
Leopold Toetsch authored
197
198 =head2 What other useful resources are there for developers?
199
de56d19 allisonrandal [cage] Updating some broken links in the gettingstarted guide.
allisonrandal authored
200 A number of other useful resources that can be found via on the Parrot
b60e8a0 Brian Gernhardt docs: misc link updates to github
Benabik authored
201 wiki, located at L<https://github.com/parrot/parrot/wiki>
e578b78 Alvis Yardley Added a DESCRIPTION. NOTE: This document 'should' be renamed to 'develop...
ayardley authored
202
203 =cut
Something went wrong with that request. Please try again.