From 8feb48485dc7ff9e8959f40aaf79df82d1223dee Mon Sep 17 00:00:00 2001
From: str4d
- So you want to start work on I2P? Great!
- Here's a quick guide to getting started
- on contributing to the website or the software, doing development or creating translations.
-
- Not quite ready for coding?
- Try getting involved first.
- {% trans %}
+So you want to start work on I2P? Great!
+Here's a quick guide to getting started
+on contributing to the website or the software, doing development or creating translations.
+{%- endtrans %} {% trans volunteer=site_url('get-involved') %}
+Not quite ready for coding?
+Try getting involved first.
+{%- endtrans %}
- Basic development on the I2P router or the embedded applications uses Java as the main development language.
- If you don't have experience with Java, you can always have a look at Thinking in Java.
-
- Study the how intro,
- the other "how" documents,
- the tech intro,
- and associated documents.
- These will give you a good overview of how I2P is structured and what different things it does.
- {% trans -%}
+Basic development on the I2P router or the embedded applications uses Java as the main development language.
+If you don't have experience with Java, you can always have a look at Thinking in Java.
+{%- endtrans %} {% trans intro=site_url('docs/how/intro'), docs=site_url('docs'), techintro=site_url('docs/how/tech-intro') -%}
+Study the how intro,
+the other "how" documents,
+the tech intro,
+and associated documents.
+These will give you a good overview of how I2P is structured and what different things it does.
+{%- endtrans %}
- For development on the i2p router or the embedded applications,
- get the monotone source repository installed - short instructions:
- {% trans -%}
+For development on the i2p router or the embedded applications,
+get the monotone source repository installed - short instructions:
+{%- endtrans %}
+ {% trans -%}
If you want to remain anonymous, you need to do an additional step, to set up a connection to a monotone server over I2P:
-
- Enable the i2ptunnel client tunnel on port 8998 pointing to mtn.i2p2.i2p.
-
-
Basic 'study'
+{% trans %}Basic study{% endtrans %}
-Getting the I2P code
+{% trans %}Getting the I2P code{% endtrans %}
-
+
{% trans i2ptunnel=site_url('docs/api/i2ptunnel') -%} + Enable the i2ptunnel client tunnel on port 8998 pointing to mtn.i2p2.i2p. + {%- endtrans %}
-mtn -d i2p.mtn db init
+ mtn -d i2p.mtn db init
~/.monotone/monotonerc
(or _MTN/monotonerc
in the i2p.i2p workspace) with the following contents:
+ ~/.monotone/monotonerc
(or _MTN/monotonerc
in the i2p.i2p workspace) with the following contents:
+{%- endtrans %}
{% include "include/monotonerc.html" %}
keys.txt
) in the same directory
+ keys.txt
) in the same directory
that i2p.mtn
is in. Import the keys into your database with mtn -d i2p.mtn read < keys.txt
- mtn -d i2p.mtn pull 127.0.0.1:8998 i2p.i2p -k""
mtn -d i2p.mtn pull 127.0.0.1:8998 i2p.i2p -k""
- Non-anonymously: mtn -d i2p.mtn pull mtn.i2p2.de i2p.i2p -k""
+ {% trans %}Non-anonymously:{% endtrans %} mtn -d i2p.mtn pull mtn.i2p2.de i2p.i2p -k""
+
{% trans -%} Alternatively, instead of 'mtn.i2p2.de', you can also download from mtn.i2p-projekt.de. -
+ {%- endtrans %}
- All the sources are now present on your machine, in the database file. To make them available in a directory, you need to check them out: mtn -d i2p.mtn co --branch=i2p.i2p
-
- The above command creates a directory i2p.i2p, which contains all of the I2P sources.
+ {% trans %}All the sources are now present on your machine, in the database file. To make them available in a directory, you need to check them out:{% endtrans %} mtn -d i2p.mtn co --branch=i2p.i2p
{% trans %}The above command creates a directory i2p.i2p, which contains all of the I2P sources.{% endtrans %}
- To download the website files instead of the I2P source files, use 'i2p.www' instead of 'i2p.i2p'. -
-- 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. -
-- A full list of branches, including i2p.i2p and i2p.www can be found on viewmtn. -
-- A long explanation about using monotone is available on the monotone page. -
+{% trans %} +To download the website files instead of the I2P source files, use 'i2p.www' instead of 'i2p.i2p'. +{%- endtrans %}
+{% trans -%} +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. +{%- endtrans %}
+{% trans viewmtn='http://stats.i2p/cgi-bin/viewmtn/' -%} +A full list of branches, including i2p.i2p and i2p.www can be found on viewmtn. +{%- endtrans %}
+{% trans monotone=site_url('get-involved/guides/monotone') -%} +A long explanation about using monotone is available on the monotone page. +{%- endtrans %}
-- To compile the code, you need the Sun Java Development Kit 6 or higher, or equivalent JDK - (Sun JDK 6 strongly recommended) and - Apache ant - version 1.7.0 or higher. - If you go are working on the main I2P code, you can go into the i2p.i2p directory and run 'ant' to see the build options. -
+{% trans sunjdk6='http://java.sun.com/javase/downloads/index.jsp' -%} +To compile the code, you need the Sun Java Development Kit 6 or higher, or equivalent JDK +(Sun JDK 6 strongly recommended) and +Apache ant +version 1.7.0 or higher. +If you go are working on the main I2P code, you can go into the i2p.i2p directory and run 'ant' to see the build options. +{%- endtrans %}
-- To build or work on console translations, you need - the xgettext, msgfmt, and msgmerge tools from the - GNU gettext package. -
+{% trans -%} +To build or work on console translations, you need +the xgettext, msgfmt, and msgmerge tools from the +GNU gettext package. +{%- endtrans %}
-- For development on new applications, - see the application development guide. -
+{% trans apps=site_url('get-involved/develop/applications') -%} +For development on new applications, +see the application development guide. +{%- endtrans %}
-- See zzz's TODO lists, - this website's TODO list or - Trac - for ideas. -
+{% trans zzz=i2pconv('zzz.i2p'), todo=site_url('get-involved/todo'), trac=i2pconv('trac.i2p2.i2p') -%} +See zzz's TODO lists, +this website's TODO list or +Trac +for ideas. +{%- endtrans %}
-- See the bottom of licenses.html for - commit privilege requirements. You need these to put code into i2p.i2p (not required for the website!). -
+{% trans licenses=site_url('get-involved/develop/licenses') -%} +See the bottom of the licenses page for +commit privilege requirements. You need these to put code into i2p.i2p (not required for the website!). +{%- endtrans %}
-- Short version of how to generate and use keys if you plan to commit: +
{% trans %}Short version of how to generate and use keys if you plan to commit:{% endtrans %}
- The developers hang around on IRC. They can be reached on the Freenode network, OFTC, and on the I2P internal networks. The usual place to look is #i2p-dev. Join the channel and say hi! - We also have additional guidelines for regular developers. -
+{% trans guidelines=site_url('get-involved/guides/dev-guidelines') -%} +The developers hang around on IRC. They can be reached on the Freenode network, OFTC, and on the I2P internal networks. The usual place to look is #i2p-dev. Join the channel and say hi! +We also have additional guidelines for regular developers. +{%- endtrans %}
-- Website and router console translators: See the New Translators Page - for next steps. -
+{% trans newtrans=site_url('get-involved/guides/new-translators') -%} +Website and router console translators: See the New Translator's Guide +for next steps. +{%- endtrans %}
-+
{% trans -%} I2P is open source software that is mostly developed using open sourced toolkits. The I2P project recently acquired a license for the YourKit Java Profiler. Open source projects are eligible to receive a free license provided that YourKit is referenced on the project web site. Please get in touch if you are interested in profiling the I2P codebase. -
+{%- endtrans %} -+
{% trans java='http://www.yourkit.com/java/profiler/index.jsp', dotnet='http://www.yourkit.com/.net/profiler/index.jsp' -%} YourKit is kindly supporting open source projects with its full-featured Java Profiler. YourKit, LLC is the creator of innovative and intelligent tools for profiling Java and .NET applications. Take a look at YourKit's leading software products: -YourKit Java Profiler and -YourKit .NET Profiler. -
+YourKit Java Profiler and +YourKit .NET Profiler. +{%- endtrans %} {% endblock %}