From 8133480b118d80371e2be992989a844224ebab2f Mon Sep 17 00:00:00 2001 From: Vladimir Dubrovin <3proxy@3proxy.ru> Date: Mon, 10 Mar 2025 14:06:29 +0300 Subject: [PATCH] Update README --- README | 31 +++++++++++++++++++++---------- 1 file changed, 21 insertions(+), 10 deletions(-) diff --git a/README b/README index fcab9d9..151706b 100644 --- a/README +++ b/README @@ -4,20 +4,22 @@ Branches: Master (stable) branch - 3proxy 0.9 -Devel branch - 3proxy 10 +Devel branch - 3proxy 10 (don't use it) -Download: - Binaries for released (master) versions (Windows, Linux): +* Download + Binaries and sources for released (master) versions (Windows, Linux): https://github.com/z3APA3A/3proxy/releases - Binaries for devel version (Windows, Linux): - https://3proxy.org/download/devel/ + Docker images: https://hub.docker.com/repository/docker/3proxy/3proxy -Archive of old versions: https://github.com/z3APA3A/3proxy-archive + Archive of old versions: https://github.com/z3APA3A/3proxy-archive +* Documentation + Documentation (man pages and HTML) available with download, on https://3proxy.org/ + and in github wiki https://github.com/3proxy/3proxy/wiki -Windows installation: +* Windows installation 3proxy --install @@ -29,7 +31,9 @@ Windows installation: removes the service (should be stopped before via 'net stop 3proxy'). -To build in Linux install git and build-essential packages, use +* To build in Linux + +install git and build-essential packages, use git clone https://github.com/z3apa3a/3proxy cd 3proxy @@ -54,7 +58,14 @@ usage: /etc/3proxy/conf/add3proxyuser.sh username password [day_limit] [bandwidt or modify /etc/3proxy/conf/ files directly. -Please read doc/html/index.html and man pages. +* For Mac OS / FreeBSD / *BSD + +git clone https://github.com/z3apa3a/3proxy +cd 3proxy +ln -s Makefile.FreeBSD Makefile +make + +(binaries are in bin/ directory) Features: 1. General @@ -217,4 +228,4 @@ Run utility with --help option for command line reference. Latest version is available from https://3proxy.org/ -Want to donate the project? https://3proxy.org/donations/ \ No newline at end of file +Want to donate the project? https://3proxy.org/donations/