1 | # I2P |
---|
2 | |
---|
3 | This is the source code for the reference Java implementation of I2P. |
---|
4 | |
---|
5 | Latest release: https://geti2p.net/download |
---|
6 | |
---|
7 | ## Installing |
---|
8 | |
---|
9 | See INSTALL.txt or https://geti2p.net/download for installation instructions. |
---|
10 | |
---|
11 | ## Documentation |
---|
12 | |
---|
13 | https://geti2p.net/how |
---|
14 | |
---|
15 | FAQ: https://geti2p.net/faq |
---|
16 | |
---|
17 | API: http://docs.i2p-projekt.de/javadoc/ |
---|
18 | or run 'ant javadoc' then start at build/javadoc/index.html |
---|
19 | |
---|
20 | ## How to contribute / Hack on I2P |
---|
21 | |
---|
22 | Please check out [HACKING.md](docs/HACKING.md) and other documents in the docs directory. |
---|
23 | |
---|
24 | ## Building packages from source |
---|
25 | |
---|
26 | To get development branch from source control: https://geti2p.net/newdevelopers |
---|
27 | |
---|
28 | ### Prerequisites |
---|
29 | |
---|
30 | - Java SDK (preferably Oracle/Sun or OpenJDK) 1.7.0 or higher |
---|
31 | - Non-linux operating systems and JVMs: See https://trac.i2p2.de/wiki/java |
---|
32 | - Certain subsystems for embedded (core, router, mstreaming, streaming, i2ptunnel) |
---|
33 | require only Java 1.6 |
---|
34 | - Apache Ant 1.7.0 or higher |
---|
35 | - The xgettext, msgfmt, and msgmerge tools installed from the GNU gettext package |
---|
36 | http://www.gnu.org/software/gettext/ |
---|
37 | - Build environment must use a UTF-8 locale. |
---|
38 | |
---|
39 | ### Ant build process |
---|
40 | |
---|
41 | On x86 systems do: |
---|
42 | |
---|
43 | ant pkg |
---|
44 | |
---|
45 | On non-x86, use one of the following instead: |
---|
46 | |
---|
47 | ant installer-linux |
---|
48 | ant installer-freebsd |
---|
49 | ant installer-osx |
---|
50 | |
---|
51 | Run 'ant' with no arguments to see other build options. |
---|
52 | |
---|
53 | ### Gradle build process |
---|
54 | |
---|
55 | Full builds of installers or updates are not yet possible, but the code can be |
---|
56 | compiled with: |
---|
57 | |
---|
58 | ./gradlew assemble |
---|
59 | |
---|
60 | This will download dependencies over the clearnet by default, including Gradle |
---|
61 | itself. To download through a SOCKS proxy (e.g. Tor), add the following lines to |
---|
62 | your `~/.gradle/gradle.properties`: |
---|
63 | |
---|
64 | systemProp.socksProxyHost=localhost |
---|
65 | systemProp.socksProxyPort=9150 |
---|
66 | |
---|
67 | ## Contact info |
---|
68 | |
---|
69 | Need help? See the IRC channel #i2p on irc.freenode.net |
---|
70 | |
---|
71 | Bug reports: https://trac.i2p2.de/report/1 |
---|
72 | |
---|
73 | Contact information, security issues, press inquiries: https://geti2p.net/en/contact |
---|
74 | |
---|
75 | Twitter: @i2p, @geti2p |
---|
76 | |
---|
77 | ## Licenses |
---|
78 | |
---|
79 | See LICENSE.txt |
---|
80 | |
---|