Browse Source

Update README.md

FIx #2456
pull/2463/head
Max Lv 5 years ago
committed by GitHub
parent
commit
3e8a57752a
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 14 additions and 25 deletions
  1. 39
      README.md

39
README.md

@ -21,28 +21,33 @@ to be a lightweight implementation of shadowsocks protocol, in order to keep the
For a full list of feature comparison between different versions of shadowsocks,
refer to the [Wiki page](https://github.com/shadowsocks/shadowsocks/wiki/Feature-Comparison-across-Different-Versions).
## Prerequisites
## Quick Start
### Get the latest source code
Snap is the recommended way to install the latest binaries.
### Install snap core
To get the latest source code, you should also update the submodules as following:
https://snapcraft.io/core
### Install from snapcraft.io
Stable channel:
```bash
git clone https://github.com/shadowsocks/shadowsocks-libev.git
cd shadowsocks-libev
git submodule update --init --recursive
sudo snap install shadowsocks-libev
```
### Build and install with recent libsodium
Edge channel:
You have to install libsodium at least 1.0.8, but recommended 1.0.12 or later version before building. See [Directly build and install on UNIX-like system](#linux).
```bash
sudo snap install shadowsocks-libev --edge
```
## Installation
### Distribution-specific guide
- [Debian & Ubuntu](#debian--ubuntu)
+ [Install from snapcraft.io](#install-from-snapcraftio)
+ [Install from repository](#install-from-repository)
+ [Build deb package from source](#build-deb-package-from-source)
+ [Configure and start the service](#configure-and-start-the-service)
@ -68,22 +73,6 @@ try `configure --help`.
### Debian & Ubuntu
#### Install from snapcraft.io
Snap is the recommended way to install the latest binaries.
Stable channel:
```bash
sudo snap install shadowsocks-libev
```
Edge channel:
```bash
sudo snap install shadowsocks-libev --edge
```
#### Install from repository
Shadowsocks-libev is available in the official repository for following distributions:

Loading…
Cancel
Save