source: README.md @ 7f6ba8cd

Last change on this file since 7f6ba8cd was ac75327, checked in by str4d <str4d@…>, 3 years ago

Refactor README.md

  • Property mode set to 100644
File size: 1.4 KB
RevLine 
[ac75327]1# I2P
[7f9a211]2
[ac75327]3This is the source code for the reference Java implementation of I2P.
[7f9a211]4
[ac75327]5Latest release: https://geti2p.net/download
[7f9a211]6
[ac75327]7## Installing
[2df64cd]8
[ac75327]9See INSTALL.txt or https://geti2p.net/download for installation instructions.
[2df64cd]10
[ac75327]11## Documentation
[2df64cd]12
[ac75327]13https://geti2p.net/how
[2df64cd]14
[ac75327]15FAQ: https://geti2p.net/faq
[2df64cd]16
[ac75327]17API: http://docs.i2p-projekt.de/javadoc/
18or run 'ant javadoc' then start at build/javadoc/index.html
[2df64cd]19
[ac75327]20## Building packages from source
[2df64cd]21
[ac75327]22To get development branch from source control: https://geti2p.net/newdevelopers
[2df64cd]23
[ac75327]24### Prerequisites
[2df64cd]25
[ac75327]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### 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## Contact info
50
51Need help? See the IRC channel #i2p on irc.freenode.net
52
53Bug reports: https://trac.i2p2.de/report/1
54
55Contact information, security issues, press inquiries: https://geti2p.net/en/contact
56
57Twitter: @i2p, @geti2p
58
59## Licenses
60
61See LICENSE.txt
[7f9a211]62
Note: See TracBrowser for help on using the repository browser.