i2p.www/www.i2p2/pages/newdevelopers.html

{% extends "_layout.html" %}
{% block title %}New Developer's Guide{% endblock %}
{% block content %}
Here's a very quick guide to getting started
on contributing to the website or the software, including translations.
<ul>
<li>
Not quite ready for coding?
Try <a href="getinvolved.html">getting involved</a> first.

<li>
For development on the i2p router or the embedded applications,
learn Java, love Java :)

<li>
Study the <a href="how_intro.html">how intro</a>,
the <a href="how.html">other "how" documents</a>,
the <a href="techintro.html">tech intro</a>,
and associated documents.

<li>
For development on the i2p router or the embedded applications,
get the monotone source repository installed - short instructions:
<ul>
<li>Install <a href="http://www.monotone.ca/">monotone</a>
<li>Skim over the <a href="http://monotone.ca/docs/Tutorial.html">monotone tutorial</a>
<li>Enable the <a href="i2ptunnel.html">i2ptunnel</a> client tunnel on port 8998 pointing to mtn.i2p2.i2p (if you are having nonce issues, see <a href="http://trac.i2p2.i2p/ticket/64">ticket #64</a> for a workaround)
<li>mtn -d i2p.mtn db init
<li>mtn -d i2p.mtn pull 127.0.0.1:8998 i2p.i2p
<li>mtn -d i2p.mtn co --branch=i2p.i2p
</ul>
Non-anonymous access: mtn.i2p2.de:4691 or mtn.i2p-projekt.de:4691
<br>
Website branch: use i2p.www instead of i2p.i2p.
<br>
The initial pull may take several hours using the tunnel.
If it fails after a partial pull, simply rerun it, it will start where it left off.
If you are in a hurry, use the non-anonymous access.
<br>
Full list of branches: see <a href="http://stats.i2p/cgi-bin/viewmtn/">viewmtn</a>.
<br>
Long version: see the <a href="monotone.html">monotone page</a>.

<li>
To compile the code, you need the Sun Java Development Kit 5 or higher, or equivalent JDK
(<a href="http://java.sun.com/javase/downloads/index.jsp">Sun JDK 6</a> strongly recommended) and
<a href="http://ant.apache.org/">Apache ant</a>
version 1.7.0 or higher.

<li>
To build or work on console translations, you need
the xgettext, msgfmt, and msgmerge tools from the
<a href="http://www.gnu.org/software/gettext/">GNU gettext package</a>.

<li>
For development on new applications,
see the <a href="applications">application development guide</a>.

<li>
See <a href="http://zzz.i2p/forums/3">zzz's TODO lists</a>, 
<a href="todo.html">this website's TODO list</a> or
<a href="http://trac.i2p2.i2p/report/2">Trac</a> 
for ideas.

<li>
Say hi to the developers on #i2p

<li>
See the bottom of <a href="licenses.html">licenses.html</a> for
commit privilege requirements. (Not required for website)

<li>
Short version of how to generate and use keys if you plan to commit:
<ul>
<li>mtn genkey yourname-transport@mail.i2p <i>(use an empty passphrase)</i>
<li>mtn genkey yourname@mail.i2p <i>(enter a passphrase)</i>
<li>mtn pubkey yourname-transport@mail.i2p <i>(<a href="mailto:mtn@welterde.de">send</a> this to a mtn repo operator to get push privileges)</i>
<li>mtn pubkey yourname@mail.i2p <i>(send this to <a href="mailto:zzz@mail.i2p">a release manager</a> to get commit privileges - not required for website)</i>
<li>mtn ci -k yourname@mail.i2p <i>(check in with this key)</i>
<li>mtn sync -k yourname-transport@mail.i2p <i>(push with this key)</i>
</ul>
Long version: see the <a href="monotone.html">monotone page</a>.

</ul>

<p>
Website and router console translators: See the <a href="newtranslators.html">New Translators Page</a>
for next steps.

{% endblock %}