source: README.md @ 9f7ec39

Last change on this file since 9f7ec39 was 89f2a76, checked in by str4d <str4d@…>, 3 years ago

Update README

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