From ac75327a7851c046088b773946d796f98a52e029 Mon Sep 17 00:00:00 2001
From: str4d <str4d@mail.i2p>
Date: Fri, 28 Jul 2017 00:45:08 +0000
Subject: [PATCH] Refactor README.md

---
 README.md | 87 +++++++++++++++++++++++++++++++------------------------
 1 file changed, 49 insertions(+), 38 deletions(-)

diff --git a/README.md b/README.md
index df6eaec0f8..b95d853d12 100644
--- a/README.md
+++ b/README.md
@@ -1,51 +1,62 @@
-Prerequisites to build from source:
-	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.
+# I2P
 
-To build:
-	On x86 systems do:
-		ant pkg
+This is the source code for the reference Java implementation of I2P.
 
-	On non-x86, use one of the following instead:
-		ant installer-linux
-		ant installer-freebsd
-		ant installer-osx
+Latest release: https://geti2p.net/download
 
-	Run 'ant' with no arguments to see other build options.
-	See INSTALL.txt or https://geti2p.net/download for installation instructions.
+## Installing
 
-Documentation:
-	https://geti2p.net/how
-	API: http://docs.i2p-projekt.de/javadoc/
-	     or run 'ant javadoc' then start at build/javadoc/index.html
+See INSTALL.txt or https://geti2p.net/download for installation instructions.
 
-Latest release:
-	https://geti2p.net/download
+## Documentation
 
-To get development branch from source control:
-	https://geti2p.net/newdevelopers
+https://geti2p.net/how
 
-FAQ:
-	https://geti2p.net/faq
+FAQ: https://geti2p.net/faq
 
-Need help?
-	IRC irc.freenode.net #i2p
-	http://forum.i2p/
+API: http://docs.i2p-projekt.de/javadoc/
+or run 'ant javadoc' then start at build/javadoc/index.html
 
-Bug reports:
-	https://trac.i2p2.de/report/1
+## Building packages from source
 
-Contact information, security issues, press inquiries:
-	https://geti2p.net/en/contact
+To get development branch from source control: https://geti2p.net/newdevelopers
 
-Twitter:
-	@i2p, @geti2p
+### Prerequisites
 
-Licenses:
-	See LICENSE.txt
+- 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.
+
+### 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.
+
+## 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
 
-- 
GitLab