Skip to content

Commit

Permalink
doc: update Readme
Browse files Browse the repository at this point in the history
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
  • Loading branch information
AmnaSnene committed Sep 23, 2024
1 parent 43448f6 commit 61ed8a1
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 12 deletions.
10 changes: 10 additions & 0 deletions Packaging.md
Original file line number Diff line number Diff line change
@@ -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
```
13 changes: 1 addition & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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)
Expand Down

0 comments on commit 61ed8a1

Please sign in to comment.