From 9f82e189708f6941a0baf3e41d87768e7869e000 Mon Sep 17 00:00:00 2001 From: Denys Fedoryshchenko Date: Wed, 28 Oct 2026 20:47:22 +0200 Subject: docs: clarify CMake requirements for build and test commands Keep the CMake 3.10 project minimum while documenting the newer CLI requirements. Add a build-directory/install-target alternative for older CMake and state the CTest requirement in the test guide. Validation: shell examples pass bash -n; local documentation links resolve. Signed-off-by: Denys Fedoryshchenko --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index af678b9e..bac35421 100644 --- a/README.md +++ b/README.md @@ -57,12 +57,26 @@ Building and installing Use an out-of-tree build directory: +The commands below require CMake 3.15 or newer: -S/-B were added in 3.13, +and --install was added in 3.15. The project itself still supports CMake 3.10. + cmake -S . -B build \ -DCMAKE_BUILD_TYPE=Release \ -DCMAKE_INSTALL_PREFIX=/usr/local cmake --build build sudo cmake --install build +For CMake 3.10 through 3.14, use the build-directory form and the generated +install target instead: + + mkdir -p build + cd build + cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=/usr/local .. + cmake --build . + sudo cmake --build . --target install + +Run the remaining examples from the repository root. + Useful build options: * BUILD_IPOE_DRIVER=TRUE builds the IPoE kernel module. -- cgit v1.2.3 From a9e7d43596c5d524b2fe9300102ab8fe20c987f5 Mon Sep 17 00:00:00 2001 From: Denys Fedoryshchenko Date: Wed, 28 Oct 2026 20:47:22 +0200 Subject: docs: specify Lua 5.1 dependencies and numeric version matching Explain that LUA=TRUE uses FindLua51, while numeric LUA values use non-EXACT FindLua version matching. Name the Lua 5.1 development package required by the test build examples. Validation: checked against accel-pppd/CMakeLists.txt and the installed FindLua51 module. Signed-off-by: Denys Fedoryshchenko --- README.md | 4 +++- tests/README.md | 3 ++- 2 files changed, 5 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index bac35421..80b0aeaa 100644 --- a/README.md +++ b/README.md @@ -49,7 +49,9 @@ development libraries: * Net-SNMP for NETSNMP=TRUE * PostgreSQL client libraries for LOG_PGSQL_DEPRECATED=TRUE -* Lua for LUA=TRUE or a specific Lua version such as LUA=5.3 +* Lua 5.1 development files for LUA=TRUE. A numeric value such as LUA=5.3 + requests at least that Lua version through CMake's FindLua module; it does + not enforce an exact version. Building and installing diff --git a/tests/README.md b/tests/README.md index ac8d016b..abf3704e 100644 --- a/tests/README.md +++ b/tests/README.md @@ -74,7 +74,8 @@ sudo apt install iproute2 ppp pppoe isc-dhcp-client ``` Install the build dependencies described in the project README, including -kernel headers and Lua development files for the options below. Run these +kernel headers and Lua 5.1 development files (`liblua5.1-0-dev` on Debian and +Ubuntu) for `LUA=TRUE` below. Run these commands from the repository root. Install accel-pppd (make install or use distro package). Do not run accel-pppd using systemd or other supervisors -- cgit v1.2.3 From deb1e9cd47097b63b6982ec0d7ca2bfdb41335e6 Mon Sep 17 00:00:00 2001 From: Denys Fedoryshchenko Date: Wed, 28 Oct 2026 20:51:56 +0200 Subject: docs: remove the obsolete ICQ contact ICQ has stopped operating, so remove the unusable contact from the README. Signed-off-by: Denys Fedoryshchenko --- README.md | 1 - 1 file changed, 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 80b0aeaa..8173ae26 100644 --- a/README.md +++ b/README.md @@ -275,5 +275,4 @@ More information * Source and issue tracker: https://github.com/accel-ppp/accel-ppp * Additional RADIUS notes: docs/ * Email: contact@accel-ppp.org -* ICQ: 337258064 * Jabber: dima@accel-ppp.org -- cgit v1.2.3 From e8945e836dc6739d10e73ea33f32959de3554cdf Mon Sep 17 00:00:00 2001 From: Denys Fedoryshchenko Date: Wed, 28 Oct 2026 20:53:15 +0200 Subject: docs: add unofficial Telegram community resources Signed-off-by: Denys Fedoryshchenko --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index 8173ae26..df116655 100644 --- a/README.md +++ b/README.md @@ -276,3 +276,13 @@ More information * Additional RADIUS notes: docs/ * Email: contact@accel-ppp.org * Jabber: dima@accel-ppp.org + + +Community resources +=================== + +These Telegram groups are unofficial community resources: + +* [English](https://t.me/accel_ppp_en) +* [Brazilian Portuguese](https://t.me/accel_ppp_br) +* [Russian](https://t.me/accel_ppp) -- cgit v1.2.3