mirror of
https://github.com/SoftEtherVPN/SoftEtherVPN.git
synced 2024-11-06 01:30:40 +03:00
Reformat README. Add compile requirements (#379)
* Reformat README. Add compile requirements * Expand the list of required packages for a successful compilation * Renamed README to README.md (Default name in github)
This commit is contained in:
parent
1f33fbdff4
commit
d94d5ed2e7
@ -40,8 +40,8 @@ by the single SoftEther VPN Server program.
|
||||
More details on http://www.softether.org/.
|
||||
|
||||
|
||||
BOARD MEMBERS OF THIS REPOSITORY
|
||||
--------------------------------
|
||||
# BOARD MEMBERS OF THIS REPOSITORY
|
||||
|
||||
|
||||
Daiyuu Nobori (Since Jan 2, 2014)
|
||||
https://github.com/dnobori
|
||||
@ -57,8 +57,8 @@ https://github.com/GildedHonour
|
||||
|
||||
|
||||
|
||||
SOFTETHER VPN ADVANTAGES
|
||||
------------------------
|
||||
# SOFTETHER VPN ADVANTAGES
|
||||
|
||||
|
||||
- Supporting all popular VPN protocols by the single VPN server:
|
||||
SSL-VPN (HTTPS)
|
||||
@ -97,8 +97,7 @@ SOFTETHER VPN ADVANTAGES
|
||||
- More details at http://www.softether.org/.
|
||||
|
||||
|
||||
GETTING STARTED
|
||||
---------------
|
||||
# GETTING STARTED
|
||||
|
||||
Visit the SoftEther VPN Project official web site at first:
|
||||
http://www.softether.org/
|
||||
@ -111,8 +110,7 @@ To build from the source,
|
||||
see "BUILD_UNIX.TXT" or "BUILD_WINDOWS.TXT" files.
|
||||
|
||||
|
||||
HOW TO DOWNLOAD THE LATEST SOURCE CODE PACKAGE
|
||||
----------------------------------------------
|
||||
# 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.
|
||||
@ -120,8 +118,7 @@ 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
|
||||
-----------------------------------------------------
|
||||
# HOW TO GET THE LATEST SOURCE CODE TREE FOR DEVELOPERS
|
||||
|
||||
If you are an open-source developer, visit our GitHub repository:
|
||||
https://github.com/SoftEtherVPN/SoftEtherVPN/
|
||||
@ -129,17 +126,40 @@ https://github.com/SoftEtherVPN/SoftEtherVPN/
|
||||
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.
|
||||
|
||||
|
||||
|
||||
## Requirements
|
||||
|
||||
### 1. Debian/Ubuntu
|
||||
|
||||
- gcc
|
||||
- libncurses-dev
|
||||
- libreadline-dev
|
||||
- make
|
||||
- openssl-dev
|
||||
|
||||
### 2. Redhat/CentOS
|
||||
- gcc
|
||||
- openssl-devel
|
||||
- make
|
||||
- ncurses-devel
|
||||
- readline-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
|
||||
```
|
||||
|
||||
|
||||
TO CIRCUMVENT YOUR GOVERNMENT'S FIREWALL RESTRICTION
|
||||
----------------------------------------------------
|
||||
|
||||
|
||||
# TO CIRCUMVENT YOUR GOVERNMENT'S FIREWALL RESTRICTION
|
||||
|
||||
Because SoftEther VPN is overly strong tool to build a VPN tunnel,
|
||||
some censorship governments want to block your access to the source code
|
||||
@ -153,13 +173,13 @@ on all the following open-source repositories:
|
||||
https://github.com/SoftEtherVPN/SoftEtherVPN/
|
||||
|
||||
To fetch the source code from GitHub:
|
||||
```
|
||||
$ git clone https://github.com/SoftEtherVPN/SoftEtherVPN.git
|
||||
|
||||
```
|
||||
We hope that you can reach one of the above URLs at least!
|
||||
|
||||
|
||||
SOURCE CODE CONTRIBUTION
|
||||
------------------------
|
||||
# SOURCE CODE CONTRIBUTION
|
||||
|
||||
Your contribution to SoftEther VPN Project is much appreciated.
|
||||
Please send patches to us through GitHub.
|
||||
@ -167,8 +187,7 @@ Read the SoftEther VPN Patch Acceptance Policy in advance:
|
||||
http://www.softether.org/5-download/src/9.patch
|
||||
|
||||
|
||||
DEAR SECURITY EXPERTS
|
||||
---------------------
|
||||
# DEAR SECURITY EXPERTS
|
||||
|
||||
If you find a bug or a security vulnerability please kindly inform us
|
||||
about the problem immediately so that we can fix the security problem
|
||||
@ -182,8 +201,7 @@ inquiry address. If you need technical assistance, please visit
|
||||
http://www.softether.org/ and ask your question on the users forum.
|
||||
|
||||
|
||||
DISCLAIMER
|
||||
----------
|
||||
# DISCLAIMER
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
||||
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
Loading…
Reference in New Issue
Block a user