Enhance installation instructions (#540)

* Enhanced documentation formatting and content

* Add TOC. Add line break to some paragraphs.

README.md

@@ -2,6 +2,17 @@
 
 [![AppVeyor build status](https://ci.appveyor.com/api/projects/status/github/softethervpn/softethervpn?branch=master&svg=true)](https://ci.appveyor.com/project/softethervpn/softethervpn) [![Travis CI build status](https://travis-ci.org/SoftEtherVPN/SoftEtherVPN.svg?branch=master)](https://travis-ci.org/SoftEtherVPN/SoftEtherVPN)
 
+- [SoftEther VPN](#softether-vpn)
+- [BOARD MEMBERS OF THIS REPOSITORY](#board-members-of-this-repository)
+- [SOFTETHER VPN ADVANTAGES](#softether-vpn-advantages)
+- [Installation](#installation)
+  * [For Ubuntu](#for-ubuntu)
+  * [From binary installers:](#from-binary-installers)
+  * [Build from Source code](#build-from-source-code)
+- [TO CIRCUMVENT YOUR GOVERNMENT'S FIREWALL RESTRICTION](#to-circumvent-your-governments-firewall-restriction)
+- [SOURCE CODE CONTRIBUTION](#source-code-contribution)
+- [DEAR SECURITY EXPERTS](#dear-security-experts)
+
 SoftEther VPN (Developer Edition Master Repository)
 - An Open-Source Cross-platform Multi-protocol VPN Program
 http://www.softether.org/
@@ -13,7 +24,7 @@ Stable Edition is available on
 https://github.com/SoftEtherVPN/SoftEtherVPN_Stable
 which the non-developer user can stable use.
 
-Source code packages (.zip and .tar.gz) and binary files of Stable Edition are also available:
+Source code packages (.zip and .tar.gz) and binary files of Stable Edition are also available:  
 http://www.softether-download.com/
 
 We accept your patches by the acceptance policy:
@@ -101,73 +112,26 @@ https://github.com/GildedHonour
 - More details at http://www.softether.org/.
 
 
-# GETTING STARTED
-
-Visit the SoftEther VPN Project official web site at first:
-        http://www.softether.org/
-
-If you are not a developer, it is recommended to download the binary
-installers from:
-        http://www.softether-download.com/
-
-To build from the source,
-see [BUILD_UNIX](src/BUILD_UNIX.md) or [BUILD_WINDOWS](src/BUILD_WINDOWS.md) files.
+# Installation
 
-# PREBUILT BINARY PACKAGES
+## For Ubuntu
 
 [Launchpad PPA](https://launchpad.net/~paskal-07/+archive/ubuntu/softethervpn/+packages) maintained by [Dmitry Verkhoturov](https://github.com/paskal)
 
-# HOW TO DOWNLOAD THE LATEST SOURCE CODE PACKAGE
-
-Go to http://www.softether-download.com/ and you can find the latest
-source-code package file in both .ZIP and .TAR.GZ format.
-
-This is the easiest way to obtain the source code of SoftEther VPN.
-
-# HOW TO GET THE LATEST SOURCE CODE TREE FOR DEVELOPERS
+## From binary installers:
 
-If you are an open-source developer, visit our GitHub repository:
-https://github.com/SoftEtherVPN/SoftEtherVPN/
+Those can be found under http://www.softether-download.com/
+There you can also find SoftEtherVPN source code in zip and tar formats.
 
-You can download the up-to-date source-code tree of SoftEther VPN
-from GitHub. You may make your own fork project from our project.
+## Build from Source code
 
+see [BUILD_UNIX](src/BUILD_UNIX.md) or [BUILD_WINDOWS](src/BUILD_WINDOWS.md)
 
+There are two flavours of SoftEtherVPN source code:
 
-##  Requirements
-
-### 1. Debian/Ubuntu
-
-- gcc
-- libncurses5-dev
-- libreadline-dev
-- make
-- cmake
-- libssl-dev
-- zlib1g-dev
-
-### 2. Red Hat/CentOS
-- gcc
-- openssl-devel
-- make
-- cmake
-- ncurses-devel
-- readline-devel
-- zlib-devel
-
-## Compile and install
-
-The download and build instruction is following:
- 
-```sh
-$ git clone https://github.com/SoftEtherVPN/SoftEtherVPN.git
-$ cd SoftEtherVPN
-$ ./configure
-$ make
-$ make install
-```
+1. Unstable. Found under https://github.com/SoftEtherVPN/SoftEtherVPN
+2. Stable. Found under https://github.com/SoftEtherVPN/SoftEtherVPN_Stable
 
-Please see src/BUILD_UNIX.md for more build instructions.
 
 # TO CIRCUMVENT YOUR GOVERNMENT'S FIREWALL RESTRICTION
 
@@ -204,7 +168,7 @@ about the problem immediately so that we can fix the security problem
 to protect a lot of users around the world as soon as possible.
 
 Our e-mail address for security reports is:
-softether-vpn-security [at] softether.org
+**softether-vpn-security at softether.org**
 
 Please note that the above e-mail address is not a technical support
 inquiry address. If you need technical assistance, please visit

src/BUILD_UNIX.md

@@ -1,9 +1,16 @@
-How to build SoftEther VPN for UNIX
-===================================
+This document describes how to build SoftEtherVPN for Unix based Operating systems
 
+- [Requirements](#requirements)
+  * [Install requirements on Centos/RedHat](#install-requirements-on-centosredhat)
+  * [Install Requirements on Debian/Ubuntu](#install-requirements-on-debianubuntu)
+- [Build from source code and instal](#build-from-source-code-and-instal)
+- [How to Run SoftEther](#how-to-run-softether)
+  * [Start/Stop SoftEther VPN Server](#startstop-softether-vpn-server)
+  * [Start/Stop SoftEther VPN Bridge](#startstop-softether-vpn-bridge)
+  * [Start/Stop SoftEther VPN Client](#startstop-softether-vpn-client)
+- [Using SoftEther without installation.](#using-softether-without-installation)
 
-Requirements
-------------
+# Requirements
 
 You need to install the following software to build SoftEther VPN for UNIX.
 
@@ -17,77 +24,60 @@ You need to install the following software to build SoftEther VPN for UNIX.
 - readline.
 - ncurses.
 
-*** It has been noted that clang is also supported as an alternative to gcc.
+*It has been noted that clang is also supported as an alternative to gcc.*
 
-For example, the following commands help you to install the above programs
-on Fedora or CentOS Linux:
-```
-$ sudo yum -y groupinstall "Development Tools"
-$ sudo yum -y install readline-devel ncurses-devel openssl-devel
-```
 
-And this command for Debian/Ubuntu:
-```
-$ sudo apt -y install gcc libncurses5-dev libreadline-dev libssl-dev make 
-```
+## Install requirements on Centos/RedHat
 
-
-How to Build
-------------
-
-To build the programs from the source code, run the following commands:
-
-```
-$ ./configure
-$ make
+```bash
+sudo yum -y groupinstall "Development Tools"
+sudo yum -y install cmake ncurses-devel openssl-devel readline-devel zlib-devel
 ```
 
-If any error occurs, please check the above requirements.
+## Install Requirements on Debian/Ubuntu
+```bash
+sudo apt -y install cmake gcc libncurses5-dev libreadline-dev libssl-dev make zlib1g-dev
+```
 
 
-How to Install SoftEther VPN Server, Bridge or Client
------------------------------------------------------
+# Build from source code and instal
 
-To install the vpnserver, vpnbridge and vpnclient programs into the
-/usr/bin directory, run the following as the root user:
+To build the programs from the source code, run the following commands:
 
-```
-# make install
+```bash
+git clone https://github.com/SoftEtherVPN/SoftEtherVPN.git
+cd SoftEtherVPN
+./configure
+make
+make install
 ```
 
-After the installation will complete successfully:
+This will compile and install SoftEther VPN Server, Bridge and Client binaries under your executable path.
 
-- Execute 'vpnserver start' to run the SoftEther VPN Server background service.
-- Execute 'vpnbridge start' to run the SoftEther VPN Bridge background service.
-- Execute 'vpnclient start' to run the SoftEther VPN Client background service.
-- Execute 'vpncmd' to run SoftEther VPN Command-Line Utility to configure
-  VPN Server, VPN Bridge or VPN Client.
+If any error occurs, please check the above requirements.
 
-- You can also use VPN Server/Client Manager GUI Tool on other Windows PC to
-  connect to VPN services remotely.
-  You can download the GUI Tools from http://www.softether-download.com/.
 
+# How to Run SoftEther
 
-How to Run SoftEther VPN Server for Test
-----------------------------------------
+## Start/Stop SoftEther VPN Server
 
 To start the SoftEther VPN Server background service, run the following:
 
-```
-$ bin/vpnserver/vpnserver start
+```bash
+vpnserver start
 ```
 
 To stop the service, run the following:
 
-```
-$ bin/vpnserver/vpnserver stop
+```bash
+vpnserver stop
 ```
 
 To configure the running SoftEther VPN Server service,
 you can use SoftEther VPN Command Line Management Utility as following:
 
-```
-$ bin/vpncmd/vpncmd
+```bash
+vpncmd
 ```
 
 Or you can also use VPN Server Manager GUI Tool on other Windows PC to
@@ -95,26 +85,25 @@ connect to the VPN Server remotely. You can download the GUI Tool
 from http://www.softether-download.com/.
 
 
-How to Run SoftEther VPN Bridge for Test
-----------------------------------------
+## Start/Stop SoftEther VPN Bridge
 
 To start the SoftEther VPN Bridge background service, run the following:
 
-```
-$ bin/vpnbridge/vpnbridge start
+```bash
+vpnbridge start
 ```
 
 To stop the service, run the following:
 
-```
-$ bin/vpnbridge/vpnbridge stop
+```bash
+vpnbridge stop
 ```
 
 To configure the running SoftEther VPN Bridge service,
 you can use SoftEther VPN Command Line Management Utility as following:
 
-```
-$ bin/vpncmd/vpncmd
+```bash
+vpncmd
 ```
 
 Or you can also use VPN Server Manager GUI Tool on other Windows PC to
@@ -122,26 +111,25 @@ connect to the VPN Bridge remotely. You can download the GUI Tool
 from http://www.softether-download.com/.
 
 
-How to Run SoftEther VPN Client for Test
-----------------------------------------
+## Start/Stop SoftEther VPN Client
 
 To start the SoftEther VPN Client background service, run the following:
 
-```
-$ bin/vpnclient/vpnclient start
+```bash
+vpnclient start
 ```
 
 To stop the service, run the following:
 
-```
-$ bin/vpnclient/vpnclient stop
+```bash
+vpnclient stop
 ```
 
 To configure the running SoftEther VPN Client service,
 you can use SoftEther VPN Command Line Management Utility as following:
 
-```
-$ bin/vpncmd/vpncmd
+```bash
+vpncmd
 ```
 
 Or you can also use VPN Client Manager GUI Tool on other Windows PC to
@@ -149,6 +137,12 @@ connect to the VPN Client remotely. You can download the GUI Tool
 from http://www.softether-download.com/.
 
 
+# Using SoftEther without installation.
+
+You can use any SoftEtherVPN component (server, client, bridge) without installing it, if you wish so.
+
+In this case please do not run the `make install` command after compiling the source code, and head directly to the **bin/** directory. There you will find the generated binaries for SoftEtherVPN and those could be used without installing SoftEtherVPN.
+
 ************************************
 Thank You Using SoftEther VPN !
 By SoftEther VPN Open-Source Project