From 61ed8a10bc1612d01e4bee42268660063d224fda Mon Sep 17 00:00:00 2001 From: Amna Date: Tue, 17 Sep 2024 17:39:42 -0400 Subject: [PATCH] doc: update Readme update Jami docs link to the connection manager. move the packaging and release section from the Readme to a separate file named packaging.md Change-Id: If665d5a15cd9237ecff12c572ce6d177c829fabf --- Packaging.md | 10 ++++++++++ README.md | 13 +------------ 2 files changed, 11 insertions(+), 12 deletions(-) create mode 100644 Packaging.md diff --git a/Packaging.md b/Packaging.md new file mode 100644 index 00000000..7f087e73 --- /dev/null +++ b/Packaging.md @@ -0,0 +1,10 @@ +# Packaging and release + +In `extras/packaging`, you will find a `build_packages.sh` script which will build packages for supported plateform. You must provide as argument the OS for which you want to build. You can't specify the plateform (arm64, x86, ...) as you can compile only for the same plateform as the one you are running on. + +**Usage:** +```bash +extras/packaging/build_packages.sh -a # -a or --all will build all plateform which are known to be supported +extras/packaging/build_packages.sh -u # -u or --ubuntu will build for all supported versions of Ubuntu +extras/packaging/build_packages.sh -u22 -d11 # -u22 will build for ubuntu 22.04 and -d11 will build for Debian 11 +``` diff --git a/README.md b/README.md index c51c1b31..ab329ddb 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ Dhtnet allows you to connect with a device simply by knowing its public key and For detailed information on using DHTNet, consult our documentation: -- [ConnectionManager Wiki](https://docs.jami.net/en_US/developer/connection-manager.html) +- [ConnectionManager Wiki](https://docs.jami.net/en_US/developer/jami-concepts/connection-manager.html) ## Getting Started @@ -97,17 +97,6 @@ DHTNet depends on the following libraries: - **[Argon2](https://github.com/P-H-C/phc-winner-argon2)**, a dependency for key stretching. - **Readline**, an optional dependency for the DHT tools. -## Packaging and release - -In `extras/packaging`, you will find a `build_packages.sh` script which will build packages for supported platform. You must provide as argument the OS for which you want to build. You are unable to specify the platform (arm64, x86, ...) as you can compile only for the same platform as the one you are running on. - -**Usage:** -```bash -extras/packaging/build_packages.sh -a # -a or --all will build all platform which are known to be supported -extras/packaging/build_packages.sh -u # -u or --ubuntu will build for all supported versions of Ubuntu -extras/packaging/build_packages.sh -u22 -d11 # -u22 will build for ubuntu 22.04 and -d11 will build for Debian 11 -``` - ## See also ### [Dnc: Distributed nc](tools/dnc/README.md)