summaryrefslogtreecommitdiff
path: root/templates/pages/development.mako
blob: 20d8054c3d8f8644654ba2c61bf2f523cf5b0f92 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
<%!
    title = "Development"
    uses_toc = True
%>
<%inherit file="/page.mako" />
<p>
    If you want to have a look at the sourcecode, or even support the development with patches or similar, you are now on the correct page :).
</p>

${self.toc()}

<%self:h2>Getting the source</%self:h2>
<p>
    Portato's sourcecode is managed with <a href="http://www.git-scm.com/">Git</a> (<strong>dev-vcs/git</strong>) and is hosted on <a href="http://github.com/Necoro/portato">GitHub</a> and <a href="http://git.necoro.eu/portato.git/">on this very server</a>. So you can chose the one you want to clone from:
</p>
<%self:hl lang="bash">
# either this
git clone git://github.com/Necoro/portato.git

# or that
git clone git://necoro.eu/portato.git
</%self:hl>
<p>
    You now should have a subdirectory <em>portato/</em>, which contains the sources. If you want to update it to reflect upstream changes, do:
</p>
<%self:hl lang="bash">
git pull
</%self:hl>
<p>
    Sometimes you need to work on a specific version (for instance if you are <a href="/translating">translating</a>). Then you need to check out the specific version branch:
</p>
<%self:hl lang="bash">
# replace '0.13' by the version you need
git checkout -b 0.13 origin/0.13
</%self:hl>
<p>
    For further information have a look at the <a href="http://www.git-scm.com/documentation">Git documentation</a> or search the webs. There are plenty of sources and guides out there.
</p>

<%self:h2>Filing a bug</%self:h2>
<p>
    You can do this in the <a href="/r/bugs">bugtracker</a>.
</p>

<%self:h2>Documentation</%self:h2>
<p>
    The code itself is documented (sometimes ^^). If you have questions, you can ask them via portato@necoro.net.
</p>
<p>
    The software itself is not documented in any way. If you like to change this, drop me a mail :). I'd be glad.
</p>

<%self:h2>Wiki/Mailing-list/...</%self:h2>
<p>
    Not there (yet?). Are they really necessary?
</p>