Update README.md to include build instructions

README.md

@@ -1,15 +1,86 @@
-XMind is an open source project that contributes to building a cutting-edge brainstorming/mind-mapping facility, focused on both usability and extendability. It helps people in capturing ideas into visually self-organized charts and sharing them for collaboration and communication. Currently supporting mind maps, fishbone diagrams, tree diagrams, org-charts, logic charts, and even spreadsheets. Often used for knowledge management, meeting minutes, task management, and GTD.
+XMind
+=====
 
-XMind is dual licensed under 2 open source licenses: the Eclipse Public License v1.0 (EPL), which is available at http://www.eclipse.org/legal/epl-v10.html , and the GNU Lesser General Public License v3 (LGPL), which is available at http://www.gnu.org/licenses/lgpl.html.
+[XMind](http://www.xmind.net) is an open source project that contributes to
+building a cutting-edge brainstorming/mind-mapping facility, focused on both
+usability and extendability. It helps people in capturing ideas into visually
+self-organized charts and sharing them for collaboration and communication.
+Currently supporting mind maps, fishbone diagrams, tree diagrams, org-charts,
+logic charts, and even spreadsheets. Often used for knowledge management,
+meeting minutes, task management, and GTD.
 
-For licensees that wish to distribute XMind 3, modify the source code, and/or build extensions, the EPL can be used to maintain copyleft of the original code base while encouraging innovation with commercial and other open source offerings incorporating XMind.
+**[Downloads Available For Windows/Mac/Ubuntu](http://www.xmind.net/download/?ref=github-home)**
 
-At the same time, for licensees that are concerned with incompatibility between the EPL and GPL, we are providing the LGPL as an option to license XMind.
+License
+-------
 
-Please note that we are not providing legal advice here and you should not rely on the above statements as such.
+XMind is dual licensed under 2 open source licenses: the [Eclipse Public
+License (EPL) v1.0](http://www.eclipse.org/legal/epl-v10.html) and the [GNU
+Lesser General Public License (LGPL) v3](http://www.gnu.org/licenses/lgpl.html).
 
-For a full understanding of your rights and obligations under these licenses, please consult the full text of the EPL and/or LGPL, and your legal counsel as appropriate.
+For licensees that wish to distribute XMind 3, modify the source code, and/or
+build extensions, the EPL can be used to maintain copyleft of the original code
+base while encouraging innovation with commercial and other open source
+offerings incorporating XMind.
 
-XMind source pack doesn't include required Eclipse plug-ins. To compile XMind source pack, you need download XMind.
+At the same time, for licensees that are concerned with incompatibility between
+the EPL and GPL, we are providing the LGPL as an option to license XMind.
+
+Please note that we are not providing legal advice here and you should not rely
+on the above statements as such. For a full understanding of your rights and
+obligations under these licenses, please consult the full text of the EPL
+and/or LGPL, and your legal counsel as appropriate.
+
+How To Run/Debug
+----------------
+
+1.  Download and install [JDK v1.8 or higher](http://www.oracle.com/technetwork/java/javase/downloads/index.html).
+1.  Download and install [Eclipse SDK v4.6 or higher](http://download.eclipse.org/eclipse/downloads/).
+1.  Make a clean workspace.
+1.  Import all bundles, features and releng projects into the workspace.
+1.  Open `org.xmind.cathy.target/cathy.target` with the default *Target Editor*
+    and click on 'Set as Target Platform' in the top-right corner of the opened
+    editor (you may have to wait for Eclipse to download all necessary
+    dependencies).
+1.  Open `org.xmind.cathy.product/cathy.product` with the default *Product
+    Configuration Editor* and, in the first 'Overview' tab, click on 'Launch an
+    Eclipse application' or 'Launch an Eclipse application in Debug mode'.
+
+And, by the way...
+
+-   If you're using an OS *other than* Windows and encounter compiling errors
+    in plugin `org.xmind.cathy.win32`, just delete it from the workspace.
+
+How To Build Executable RCP Product
+-----------------------------------
+
+1.  Download and install [JDK v1.8 or higher](http://www.oracle.com/technetwork/java/javase/downloads/index.html).
+1.  Download and install [Eclipse SDK v4.6 or higher](http://download.eclipse.org/eclipse/downloads/).
+1.  Download and install [Maven v3.3 or higher](http://maven.apache.org/).
+1.  Open Terminal on Mac/Linux (or cmd.exe on Windows), and execute these
+    *magical* commands (you may have to replace some paths to meet your
+    environment):
+
+    ```
+    cd /the/path/to/github/xmind
+    mvn clean verify
+    /the/path/to/eclipse -nosplash -consoleLog -application org.eclipse.equinox.p2.director -repository file:/the/path/to/github/xmind/releng/org.xmind.product/target/repository/ -installIU org.xmind.cathy.product -profile XMindProfile -roaming -destination /the/path/to/target/xmind -p2.os win32|macosx|linux -p2.ws win32|cocoa|gtk -p2.arch x86|x86_64
+    ```
+
+    For all available options of the *p2 director application* and what they
+    mean, see [Eclipse Help](http://help.eclipse.org/mars/index.jsp?topic=%2Forg.eclipse.platform.doc.isv%2Fguide%2Fp2_director.html).
+
+1.  You should now see an executable XMind application in the
+    `/the/path/to/target/xmind` directory.
+
+And, by the way...
+
+-   Don't try building a macOS application or Linux package on a *Windows*
+    platform, because doing so will make the application lack of *executable*
+    file permission.
+
+How To Contribute
+-----------------
+
+Any issue report or pull request will be highly welcomed!
 
-**[Download XMind for Windows/Mac/Ubuntu Now!](http://www.xmind.net/download/)**