Files
i2p.i2p/README.md

77 lines
1.8 KiB
Markdown
Raw Normal View History

2017-07-28 00:45:08 +00:00
# I2P
2017-07-28 00:45:08 +00:00
This is the source code for the reference Java implementation of I2P.
2017-07-28 00:45:08 +00:00
Latest release: https://geti2p.net/download
2017-07-28 00:45:08 +00:00
## Installing
2017-07-28 00:45:08 +00:00
See INSTALL.txt or https://geti2p.net/download for installation instructions.
2017-07-28 00:45:08 +00:00
## Documentation
2017-07-28 00:45:08 +00:00
https://geti2p.net/how
2017-07-28 00:45:08 +00:00
FAQ: https://geti2p.net/faq
2017-07-28 00:45:08 +00:00
API: http://docs.i2p-projekt.de/javadoc/
or run 'ant javadoc' then start at build/javadoc/index.html
2017-07-28 00:45:08 +00:00
## Building packages from source
2017-07-28 00:45:08 +00:00
To get development branch from source control: https://geti2p.net/newdevelopers
2017-07-28 00:45:08 +00:00
### Prerequisites
2017-07-28 00:45:08 +00:00
- Java SDK (preferably Oracle/Sun or OpenJDK) 1.7.0 or higher
- Non-linux operating systems and JVMs: See https://trac.i2p2.de/wiki/java
- Certain subsystems for embedded (core, router, mstreaming, streaming, i2ptunnel)
require only Java 1.6
- Apache Ant 1.7.0 or higher
- The xgettext, msgfmt, and msgmerge tools installed from the GNU gettext package
http://www.gnu.org/software/gettext/
- Build environment must use a UTF-8 locale.
2017-11-26 23:27:59 +00:00
### Ant build process
2017-07-28 00:45:08 +00:00
On x86 systems do:
ant pkg
On non-x86, use one of the following instead:
ant installer-linux
ant installer-freebsd
ant installer-osx
Run 'ant' with no arguments to see other build options.
2017-11-26 23:27:59 +00:00
### Gradle build process
Full builds of installers or updates are not yet possible, but the code can be
compiled with:
./gradlew assemble
This will download dependencies over the clearnet by default, including Gradle
itself. To download through a SOCKS proxy (e.g. Tor), add the following lines to
your `~/.gradle/gradle.properties`:
systemProp.socksProxyHost=localhost
systemProp.socksProxyPort=9150
2017-07-28 00:45:08 +00:00
## Contact info
Need help? See the IRC channel #i2p on irc.freenode.net
Bug reports: https://trac.i2p2.de/report/1
Contact information, security issues, press inquiries: https://geti2p.net/en/contact
Twitter: @i2p, @geti2p
## Licenses
See LICENSE.txt