From 720806317b877e264e5940f5c067f6df7e50564c Mon Sep 17 00:00:00 2001 From: Fancy Zhang Date: Sat, 4 Jul 2020 15:54:31 +0800 Subject: [PATCH] update readme --- readme.md | 22 ++++++++++++++++------ 1 file changed, 16 insertions(+), 6 deletions(-) diff --git a/readme.md b/readme.md index 66d21e5..3ec5da6 100644 --- a/readme.md +++ b/readme.md @@ -16,9 +16,9 @@ Main feature: ## Contents - - * [Transparent Proxy with cgroup v2](#transparent-proxy-with-cgroup-v2) + * [Transparent Proxy powered by cgroup v2](#transparent-proxy-powered-by-cgroup-v2) * [Introduction](#introduction) + * [Contents](#contents) * [Prerequest](#prerequest) * [How to install](#how-to-install) * [Default usage](#default-usage) @@ -29,8 +29,9 @@ Main feature: * [NOTES](#notes) * [TIPS](#tips) * [Licences](#licences) + * [Known Issus](#known-issus) - + @@ -54,6 +55,18 @@ Main feature: ## How to install +### main depency + +| os | build depency | runtime depency | download | +| --------- | ------------------------------------------------------------ | ----------------------------------------------------- | ------------------------------------------------------------ | +| Archlinux | clang, nlohmann-json, libbpf | libbpf | [archlinux AUR](https://aur.archlinux.org/packages/?K=cgproxy) | +| Ubuntu | clang, nlohmann-json, [libbpf-dev](https://packages.ubuntu.com/groovy/libbpf-dev) | [libbpf0](https://packages.ubuntu.com/groovy/libbpf0) | [Release page](https://github.com/springzfx/cgproxy/releases) | +| Fedora | clang, nlohmann-json,[libbpf](https://src.fedoraproject.org/rpms/libbpf) | [libbpf](https://src.fedoraproject.org/rpms/libbpf) | [Release page](https://github.com/springzfx/cgproxy/releases) | + +tested in arch and ubuntu 20.04. + +### build + ```bash # mkdir build && cd build @@ -61,9 +74,6 @@ mkdir build && cd build cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=/usr .. && make install ``` -- It is alreay in [archlinux AUR](https://aur.archlinux.org/packages/?K=cgproxy). - - ## Default usage - First enable and start service