yetangitu/ffsend
1
0
Fork 0
mirror of https://github.com/timvisee/ffsend.git synced 2025-10-03 09:39:15 +02:00
Code Issues Projects Releases Packages Wiki Activity

Add FreeBSD installation and building instructions

Browse source
This commit is contained in:
Mateusz Piotrowski 2019-05-02 18:30:44 +02:00
parent d5bc5a4289
commit dda9f2c8a1
1 changed files with 22 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

24
README.md
View file

@ -33,7 +33,7 @@ Find out more about security [here](#security).
- [Features](#features) - [Features](#features)
- [Usage](#usage) - [Usage](#usage)
- [Requirements](#requirements) - [Requirements](#requirements)
- [Install](#install) ([Linux](#linux-all-distributions), [macOS](#macos), [Windows](#windows), [_Other OS/arch_](#other-os-or-architecture)) - [Install](#install) ([FreeBSD](#freebsd), [Linux](#linux-all-distributions), [macOS](#macos), [Windows](#windows), [_Other OS/arch_](#other-os-or-architecture))
- [Build](#build) - [Build](#build)
- [Configuration and environment](#configuration-and-environment) - [Configuration and environment](#configuration-and-environment)
- [Security](#security) - [Security](#security)
@ -132,7 +132,7 @@ Use the `--help` flag, `help` subcommand, or see the [help](#help) section for
all available subcommands. all available subcommands.
## Requirements ## Requirements
- Linux, Windows or macOS - FreeBSD, Linux, macOS or Windows
- A terminal :sunglasses: - A terminal :sunglasses:
- Internet connection for uploading and downloading - Internet connection for uploading and downloading
- Linux specific: - Linux specific:
@ -146,6 +146,10 @@ all available subcommands.
- OpenSSL v1.1.0j: [» Installer][openssl-windows-installer] - OpenSSL v1.1.0j: [» Installer][openssl-windows-installer]
- macOS specific: - macOS specific:
- OpenSSL: `brew install openssl@1.1` - OpenSSL: `brew install openssl@1.1`
- FreeBSD specific:
- OpenSSL: `pkg install openssl`
- CA certificates: `pkg install ca_root_nss`
- Optional `xclip` & `xsel` for clipboard support: `pkg install xclip xsel-conrad`
## Install ## Install
Because `ffsend` is still in alpha, only limited installation options are Because `ffsend` is still in alpha, only limited installation options are
@ -154,11 +158,23 @@ available right now.
Make sure you meet and install the [requirements](#requirements). Make sure you meet and install the [requirements](#requirements).
See the operating system specific instructions below: See the operating system specific instructions below:
- [FreeBSD](#freebsd)
- [Linux](#linux-all-distributions) - [Linux](#linux-all-distributions)
- [macOS](#macos) - [macOS](#macos)
- [Windows](#windows) - [Windows](#windows)
- [_Other OS or architecture_](#other-os-or-architecture) - [_Other OS or architecture_](#other-os-or-architecture)
### FreeBSD
[» `ffsend`][freshports-ffsend]
```sh
# Precompiled binary.
pkg install ffsend
# Compiles and installs from source.
cd /usr/ports/www/ffsend && make install
```
### Linux (all distributions) ### Linux (all distributions)
Using the [snap](#linux-snap-package) package is recommended if supported. Using the [snap](#linux-snap-package) package is recommended if supported.
Alternatively you may install it manually using the Alternatively you may install it manually using the
@ -385,6 +401,9 @@ before proceeding:
- [`git`][git] - [`git`][git]
- [`rust`][rust] `v1.32` or higher (install using [`rustup`][rustup]) - [`rust`][rust] `v1.32` or higher (install using [`rustup`][rustup])
- [OpenSSL][openssl] or [LibreSSL][libressl] libraries and headers must be available - [OpenSSL][openssl] or [LibreSSL][libressl] libraries and headers must be available
- FreeBSD:
- `pkg install rust gmake pkgconf python36 libxcb xclip ca_root_nss xsel-conrad`
- It is a better idea to use & modify the existing `ffsend` port, which manages dependencies for you.
- Linux: - Linux:
- Ubuntu, Debian and derivatives: `apt install build-essential cmake pkg-config libssl-dev` - Ubuntu, Debian and derivatives: `apt install build-essential cmake pkg-config libssl-dev`
- CentOS/Red Hat/openSUSE: `yum install gcc gcc-c++ make cmake openssl-devel` - CentOS/Red Hat/openSUSE: `yum install gcc gcc-c++ make cmake openssl-devel`
@ -755,3 +774,4 @@ Check out the [LICENSE](LICENSE) file for more information.
[wsl]: https://docs.microsoft.com/en-us/windows/wsl/install-win10 [wsl]: https://docs.microsoft.com/en-us/windows/wsl/install-win10
[docker-hub-ffsend]: https://hub.docker.com/r/timvisee/ffsend [docker-hub-ffsend]: https://hub.docker.com/r/timvisee/ffsend
[scoop-install]: https://scoop.sh/#installs-in-seconds [scoop-install]: https://scoop.sh/#installs-in-seconds
[freshports-ffsend]: https://www.freshports.org/www/ffsend