dandri/i2p.i2p
1
0
Fork 0
mirror of https://github.com/i2p/i2p.i2p.git synced 2026-03-29 07:39:57 +00:00
Code Issues Packages Projects Releases Wiki Activity

Docs: Update README (Gitea PR #528)

Browse Source 
as authored by mark22k
This commit is contained in:
zzz
2026-02-19 08:15:54 -05:00
parent a1d93169d1
commit 3a068f08f9
1 changed files with 11 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@@ -2,7 +2,7 @@
This is the source code for the reference Java implementation of I2P. This is the source code for the reference Java implementation of I2P.
Latest release: [https://i2p.net/download](https://i2p.net/download) Latest release: [https://i2p.net/download](https://i2p.net/download)
## Installing ## Installing
@@ -12,9 +12,9 @@ See [INSTALL.txt](INSTALL.txt) or [https://i2p.net/download](https://i2p.net/dow
[https://i2p.net/how](https://i2p.net/how) [https://i2p.net/how](https://i2p.net/how)
FAQ: [https://i2p.net/faq](https://i2p.net/faq) FAQ: [https://i2p.net/faq](https://i2p.net/faq)
API: [http://docs.i2p-projekt.de/javadoc/](http://docs.i2p-projekt.de/javadoc/) API: [http://docs.i2p-projekt.de/javadoc/](http://docs.i2p-projekt.de/javadoc/)
or run 'ant javadoc' then start at build/javadoc/index.html or run 'ant javadoc' then start at build/javadoc/index.html
## How to contribute / Hack on I2P ## How to contribute / Hack on I2P
@@ -23,17 +23,17 @@ Please check out [HACKING.md](docs/HACKING.md) and other documents in the docs d
## Building packages from source ## Building packages from source
To get development branch from source control: [https://i2p.net/newdevelopers](https://i2p.net/newdevelopers) To get development branch from source control: [https://i2p.net/newdevelopers](https://i2p.net/newdevelopers)
### Prerequisites ### Prerequisites
- Java SDK (preferably Oracle or OpenJDK) 17 or higher - Java SDK (preferably Oracle or OpenJDK) 17 or higher
- Non-linux operating systems and JVMs: See [https://trac.i2p2.de/wiki/java](https://trac.i2p2.de/wiki/java) - Non-linux operating systems and JVMs: See [https://trac.i2p2.de/wiki/java](https://trac.i2p2.de/wiki/java)
- Certain subsystems for embedded (core, router, mstreaming, streaming, i2ptunnel) - Certain subsystems for embedded (core, router, mstreaming, streaming, i2ptunnel)
require only Java 6 require only Java 6
- Apache Ant 1.9.8 or higher - Apache Ant 1.9.8 or higher
- The xgettext, msgfmt, and msgmerge tools installed from the GNU gettext package - The xgettext, msgfmt, and msgmerge tools installed from the GNU gettext package
[http://www.gnu.org/software/gettext/](http://www.gnu.org/software/gettext/) [http://www.gnu.org/software/gettext/](http://www.gnu.org/software/gettext/)
- Build environment must use a UTF-8 locale. - Build environment must use a UTF-8 locale.
### Ant build process ### Ant build process
@@ -68,18 +68,20 @@ your `~/.gradle/gradle.properties`:
Automatic CI builds are available at the [continuous integration](https://github.com/i2p/i2p.i2p/actions/workflows/ant.yml) page. Automatic CI builds are available at the [continuous integration](https://github.com/i2p/i2p.i2p/actions/workflows/ant.yml) page.
### Docker ### Docker
For more information how to run I2P in Docker, see [Docker.md](Docker.md) For more information how to run I2P in Docker, see [Docker.md](Docker.md)
## Contact info ## Contact info
Need help? See the IRC channel #i2p on irc.freenode.net Need help? See the IRC channel #i2p on irc.freenode.net
Bug reports: [https://i2pgit.org/i2p-hackers/i2p.i2p/-/issues](https://i2pgit.org/i2p-hackers/i2p.i2p/-/issues) [http://git.idk.i2p/i2p-hackers/i2p.i2p/-/issues](http://git.idk.i2p/i2p-hackers/i2p.i2p/-/issues) Bug reports: [https://i2pgit.org/I2P_Developers/i2p.i2p/-/issues](https://i2pgit.org/I2P_Developers/i2p.i2p/-/issues) [http://git.idk.i2p/I2P_Developers/i2p.i2p/-/issues](http://git.idk.i2p/I2P_Developers/i2p.i2p/-/issues)
Contact information, security issues, press inquiries: [https://i2p.net/en/contact](https://i2p.net/en/contact) Contact information, security issues, press inquiries: [https://i2p.net/en/contact](https://i2p.net/en/contact)
Twitter: [@i2p](https://twitter.com/i2p), [@geti2p](https://twitter.com/GetI2P) Twitter: [@i2p](https://twitter.com/i2p), [@geti2p](https://twitter.com/GetI2P)
## Licenses ## Licenses
See [LICENSE.txt](LICENSE.txt) See [LICENSE.txt](LICENSE.txt)