JBR-3590 Update JetBrains Runtime README

README.md

@@ -1,13 +1,132 @@
 [![official JetBrains project](http://jb.gg/badges/official.svg)](https://confluence.jetbrains.com/display/ALL/JetBrains+on+GitHub)
 
-# Welcome to the JDK!
+# Welcome to JetBrains Runtime!
 
-For build instructions please see the
-[online documentation](https://openjdk.java.net/groups/build/doc/building.html),
-or either of these files:
+JetBrains Runtime is a fork of [OpenJDK](https://github.com/openjdk/jdk) available for Windows, Mac OS X, and Linux.
+It includes a number enhancements in font rendering, HiDPI support, ligatures, performance improvements, and bugfixes.
 
-- [doc/building.html](doc/building.html) (html version)
-- [doc/building.md](doc/building.md) (markdown version)
+## Contents
+- [Welcome to JetBrains Runtime](#jetbrains-runtime)
+  - [Products Built on JetBrains Runtime](#products-built-on-jetbrains-runtime)
+  - [Getting Sources](#getting-sources)
+    - [macOS, Linux](#macos-linux)
+    - [Windows](#sources-windows)
+  - [Configuring the Build Environment](#configuring-the-build-environment)
+    - [Linux (Docker)](#linux-docker)
+    - [Ubuntu Linux](#ubuntu-linux)
+    - [Windows](#build-windows)
+    - [macOS](#macos)
+  - [Contributing](#contributing)
+  - [Resources](#resources)
 
-See <https://openjdk.java.net/> for more information about
-the OpenJDK Community and the JDK.
+## Products Built on JetBrains Runtime
+* [Android Studio](https://developer.android.com/studio). The official IDE for Google's Android operating system.
+* [CLion](https://www.jetbrains.com/clion/). A cross-platform IDE for C and C++ from JetBrains.
+* [DataGrip](https://www.jetbrains.com/datagrip/). The IDE for Databases and SQL from JetBrains.
+* [GoLand](https://www.jetbrains.com/go/). The cross-platform Go IDE from JetBrains.
+* [IntelliJ IDEA](https://www.jetbrains.com/idea/). The IDE for JVM from JetBrains.
+* [JProfiler](https://www.ej-technologies.com/products/jprofiler/overview.html). The Java profiler.
+* [PhpStorm](https://www.jetbrains.com/phpstorm/). The PHP IDE from JetBrains.
+* [PyCharm](https://www.jetbrains.com/pycharm/). The Python IDE from JetBrains.
+* [Rider](https://www.jetbrains.com/rider/). The cross-platform .NET IDE from JetBrains.
+* [RubyMine](https://www.jetbrains.com/ruby/). The Ruby and Rails IDE from JetBrains.
+* [WebStorm](https://www.jetbrains.com/webstorm/). The JavaScript IDE from JetBrains.
+* [YourKit](https://www.yourkit.com/). Java and .NET profilers.
+
+## Getting Sources
+### macOS, Linux
+```
+git config --global core.autocrlf input
+git clone git@github.com:JetBrains/JetBrainsRuntime.git
+```
+
+### Windows
+<a name="sources-windows"></a>
+```
+git config --global core.autocrlf false
+git clone git@github.com:JetBrains/JetBrainsRuntime.git
+```
+
+## Configuring the Build Environment
+Here are quick per-platform instructions for those who can't wait to get started. 
+Please refer to [OpenJDK build docs](http://hg.openjdk.java.net/jdk/jdk11/raw-file/tip/doc/building.html) for in-depth
+coverage of all the details.
+
+> **_TIP:_**  To get a preliminary report of what's missing, run `./configure` and check its output. 
+> It would usually have a meaningful advice on how to solve the problem.
+
+### Linux (Docker)
+Create a container:
+```
+$ cd jb/project/docker
+$ docker build .
+...
+Successfully built 942ea9900054
+```
+Run these commands in the new container:
+```
+$ docker run -v `pwd`../../../../:/JetBrainsRuntime -it 942ea9900054
+# cd /JetBrainsRuntime
+# sh ./configure
+# make images CONF=linux-x86_64-normal-server-release
+```
+
+### Ubuntu Linux
+Install the necessary tools, libraries, and headers with:
+```
+$ sudo apt-get install autoconf make build-essential libx11-dev libxext-dev libxrender-dev libxtst-dev \
+       libxt-dev libxrandr-dev libcups2-dev libfontconfig1-dev libasound2-dev 
+```
+Then run the following:
+```
+$ cd JetBrainsRuntime
+$ sh ./configure --disable-warnings-as-errors
+$ make images
+```
+
+### Windows
+<a name="build-windows"></a>
+Install the following:
+* [Cygwin x64](http://www.cygwin.com/).
+  Required packages: `autoconf`, `binutils`, `cpio`, `diffutils`, `file`, `gawk`, `gcc-core`, `make`, `m4`, `unzip`, `zip`.  
+  Install those together with Cygwin.
+* [Visual Studio compiler toolset](https://visualstudio.microsoft.com/downloads/).
+  Install with the desktop development kit, which includes Windows SDK and compilers.
+  Visual Studio 2015 is supported by default.
+* [Java 11](http://www.oracle.com/technetwork/java/javase/downloads/index.html). 
+  If you have problems while configuring, read [Java tips on Cygwin](http://horstmann.com/articles/cygwin-tips.html).
+
+From the command line: 
+```
+"c:\Program Files (x86)\Microsoft Visual Studio 14.0\VC\vcvarsall.bat" amd64
+"c:\Program_Files\cygwin64\bin\mintty.exe" /bin/bash -l
+```
+The first command sets up environment variables, the second starts a Cygwin shell with the proper environment.  
+
+In the Cygwin shell: 
+```
+$ cd JetBrainsRuntime
+$ bash configure --enable-option-checking=fatal --with-toolchain-version=2015 \
+                 --with-boot-jdk="/cygdrive/c/Program Files/Java/jdk-11.0.5" --disable-warnings-as-errors
+$ make images
+```
+
+### macOS
+Install Xcode command line developer tools and `autoconf` via [Homebrew](getDpiInfo).
+
+From the command line:
+```
+$ cd JetBrainsRuntime
+$ sh ./configure --prefix=$(pwd)/build  --disable-warnings-as-errors
+$ make images
+```
+
+## Contributing
+We are happy to receive your pull requests! 
+Before you submit one, please sign our [Contributor License Agreement (CLA)](https://www.jetbrains.com/agreements/cla/).
+
+## Resources
+* [JetBrains Runtime on github](https://github.com/JetBrains/JetBrainsRuntime)
+* [OpenJDK build instructions](http://hg.openjdk.java.net/jdk/jdk11/raw-file/tip/doc/building.html)
+* [OpenJDK test instructions](http://hg.openjdk.java.net/jdk/jdk11/raw-file/tip/doc/building.html#running-tests)
+* [How to develop OpenJDK with CLion](https://blog.jetbrains.com/clion/2020/03/openjdk-with-clion/)