forked from I2P_Developers/i2p.i2p
b98254b2be
this is specially important for our GitHub impression which I suspect most coders will have their first meeting with I2P on. The documentation is far from done but it should make value for any new developer by this time so I've decided to push them. It losly describes our build systems, and has a monotone cheat sheet which always has an "git equalent" so it's easier to handle for people used to git.
81 lines
1.9 KiB
Markdown
81 lines
1.9 KiB
Markdown
# I2P
|
|
|
|
This is the source code for the reference Java implementation of I2P.
|
|
|
|
Latest release: https://geti2p.net/download
|
|
|
|
## Installing
|
|
|
|
See INSTALL.txt or https://geti2p.net/download for installation instructions.
|
|
|
|
## Documentation
|
|
|
|
https://geti2p.net/how
|
|
|
|
FAQ: https://geti2p.net/faq
|
|
|
|
API: http://docs.i2p-projekt.de/javadoc/
|
|
or run 'ant javadoc' then start at build/javadoc/index.html
|
|
|
|
## How to contribute / Hack on I2P
|
|
|
|
Please check out [README.HACKING.md](README.HACKING.md)
|
|
|
|
## Building packages from source
|
|
|
|
To get development branch from source control: https://geti2p.net/newdevelopers
|
|
|
|
### Prerequisites
|
|
|
|
- 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.
|
|
|
|
### Ant build process
|
|
|
|
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.
|
|
|
|
### 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
|
|
|
|
## 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
|
|
|