From 23b2975e5900a4d64bd623421eda19a7e6a389b8 Mon Sep 17 00:00:00 2001
From: Roman Shevchenko <roman.shevchenko@jetbrains.com>
Date: Thu, 8 Jun 2017 13:15:58 +0300
Subject: [PATCH] Cleanup (escaping and other fixes in decompiler/README.md)

---
 plugins/java-decompiler/engine/README.md | 43 +++++++++++-------------
 1 file changed, 20 insertions(+), 23 deletions(-)

diff --git a/plugins/java-decompiler/engine/README.md b/plugins/java-decompiler/engine/README.md
index 24a32f2edd5a..abc48715a5bb 100644
--- a/plugins/java-decompiler/engine/README.md
+++ b/plugins/java-decompiler/engine/README.md
@@ -1,36 +1,36 @@
-## About fernflower
+### About Fernflower
 
 Fernflower is the first actually working analytical decompiler for Java and 
 probably for a high-level programming language in general. Naturally it is still 
 under development, please send your bug reports and improvement suggestions at 
 fernflower.decompiler@gmail.com
 
+### Licence
 
-## Licence
+Fernflower is licenced under the [Apache Licence Version 2.0](http://www.apache.org/licenses/LICENSE-2.0).
 
-Fernflower is licenced under the Apache Licence Version 2.0. It can be found here: http://www.apache.org/licenses/LICENSE-2.0
+### Running from command line
 
-## Running from command line
-
-java -jar fernflower.jar [-<option>=<value>]* [<source>]+ <destination>
+`java -jar fernflower.jar [-<option>=<value>]* [<source>]+ <destination>`
 
 \* means 0 or more times\
 \+ means 1 or more times
 
-<source>: file or directory with files to be decompiled. Directories are recursively scanned. Allowed file extensions are class, zip and jar.
+\<source>: file or directory with files to be decompiled. Directories are recursively scanned. Allowed file extensions are class, zip and jar.
           Sources prefixed with -e= mean "library" files that won't be decompiled, but taken into account when analysing relationships between 
           classes or methods. Especially renaming of identifiers (s. option 'ren') can benefit from information about external classes.          
-<destination>: destination directory 
-<option>,<value>: command line option with the corresponding value, see 4.
 
-### Examples
+\<destination>: destination directory 
 
-java -jar fernflower.jar -hes=0 -hdc=0 c:\Temp\binary\ -e=c:\Java\rt.jar c:\Temp\source\
+\<option>, \<value>: a command-line option with the corresponding value (see "Command-line options" below).
 
-java -jar fernflower.jar -dgs=1 c:\Temp\binary\library.jar c:\Temp\binary\Boot.class c:\Temp\source\
+##### Examples:
 
+`java -jar fernflower.jar -hes=0 -hdc=0 c:\Temp\binary\ -e=c:\Java\rt.jar c:\Temp\source\`
 
-## Command line options
+`java -jar fernflower.jar -dgs=1 c:\Temp\binary\library.jar c:\Temp\binary\Boot.class c:\Temp\source\`
+
+### Command-line options
 
 With the exception of mpm and urc the value of 1 means the option is activated, 0 - deactivated. Default 
 value, if any, is given between parentheses.
@@ -59,18 +59,15 @@ The rest of options can be left as they are: they are aimed at professional reve
 - fdi (1): de-inline finally structures
 - mpm (0): maximum allowed processing time per decompiled method, in seconds. 0 means no upper limit
 - ren (0): rename ambiguous (resp. obfuscated) classes and class elements
-- urc    : full name of user-supplied class implementing IIdentifierRenamer. It is used to determine which class identifiers
-         should be renamed and provides new identifier names. For more information see section 5
+- urc: full name of user-supplied class implementing IIdentifierRenamer. It is used to determine which class identifiers
+         should be renamed and provides new identifier names (see "Renaming identifiers")
 - inn (1): check for IntelliJ IDEA-specific @NotNull annotation and remove inserted code if found
 - lac (0): decompile lambda expressions to anonymous classes
 - nls (0): define new line character to be used for output. 0 - '\r\n' (Windows), 1 - '\n' (Unix), default is OS-dependent
-- ind    : indentation string (default is "   " (3 spaces))
- 
-The default logging level is INFO. This value can be overwritten by setting the option 'log' as follows:
-log (INFO): possible values TRACE, INFO, WARN, ERROR
+- ind: indentation string (default is 3 spaces)
+- log (INFO): a logging level, possible values are TRACE, INFO, WARN, ERROR
 
-
-## Renaming identifiers
+### Renaming identifiers
 
 Some obfuscators give classes and their member elements short, meaningless and above all ambiguous names. Recompiling of such
 code leads to a great number of conflicts. Therefore it is advisable to let the decompiler rename elements in its turn, 
@@ -78,10 +75,10 @@ ensuring uniqueness of each identifier.
 
 Option 'ren' (i.e. -ren=1) activates renaming functionality. Default renaming strategy goes as follows:
 - rename an element if its name is a reserved word or is shorter than 3 characters
-- new names are built according to a simple pattern: (class|method|field)_<consecutive unique number>  
+- new names are built according to a simple pattern: (class|method|field)_\<consecutive unique number>  
 You can overwrite this rules by providing your own implementation of the 4 key methods invoked by the decompiler while renaming. Simply 
 pass a class that implements org.jetbrains.java.decompiler.main.extern.IIdentifierRenamer in the option 'urc'
-(e.g. -urc=com.mypackage.MyRenamer) to Fernflower. The class must be available on the application classpath.
+(e.g. -urc=com.example.MyRenamer) to Fernflower. The class must be available on the application classpath.
 
 The meaning of each method should be clear from naming: toBeRenamed determine whether the element will be renamed, while the other three
 provide new names for classes, methods and fields respectively.