1
0
mirror of https://github.com/qTox/qTox.git synced 2024-03-22 14:00:36 +08:00

docs(INSTALL): fix formatting after github changed its markdown parser

This commit is contained in:
Zetok Zalbavar 2017-03-23 17:21:32 +00:00
parent f839abf33f
commit 9236763865
No known key found for this signature in database
GPG Key ID: C953D3880212068A

View File

@ -36,7 +36,6 @@
- [Windows](#windows) - [Windows](#windows)
- [Compile-time switches](#compile-time-switches) - [Compile-time switches](#compile-time-switches)
<a name="dependencies" />
## Dependencies ## Dependencies
| Name | Version | Modules | | Name | Version | Modules |
@ -100,9 +99,9 @@ Disabled by default.
To enable: `-DENABLE_APPINDICATOR=True` To enable: `-DENABLE_APPINDICATOR=True`
<a name="linux" />
## Linux ## Linux
### Simple install ### Simple install
Easy qTox install is provided for variety of distributions: Easy qTox install is provided for variety of distributions:
* [Arch](#arch) * [Arch](#arch)
@ -121,34 +120,40 @@ Link | Distros | Architecture
For release version, install `qtox`. To get latest changes, install For release version, install `qtox`. To get latest changes, install
`qtox-alpha`. `qtox-alpha`.
==== ---
<a name="arch-easy" /> <a name="arch-easy" />
#### Arch #### Arch
PKGBUILD is available in the `community` repo, to install: PKGBUILD is available in the `community` repo, to install:
```bash ```bash
pacman -S qtox pacman -S qtox
``` ```
<a name="gentoo-easy" /> <a name="gentoo-easy" />
#### Gentoo #### Gentoo
qTox is available in Gentoo. qTox is available in Gentoo.
To install: To install:
```bash ```bash
emerge qtox emerge qtox
``` ```
<a name="slackware-easy" /> <a name="slackware-easy" />
#### Slackware #### Slackware
qTox SlackBuild and all of its dependencies can be found here: qTox SlackBuild and all of its dependencies can be found here:
http://slackbuilds.org/repository/14.1/network/qTox/ http://slackbuilds.org/repository/14.1/network/qTox/
<a name="freebsd-easy" /> <a name="freebsd-easy" />
#### FreeBSD #### FreeBSD
A qTox port is available at ``net-im/qTox``. To build and install qTox: A qTox port is available at ``net-im/qTox``. To build and install qTox:
@ -176,39 +181,51 @@ In order to clone the qTox repository you need Git.
<a name="arch-git" /> <a name="arch-git" />
#### Arch Linux #### Arch Linux
```bash ```bash
sudo pacman -S --needed git sudo pacman -S --needed git
``` ```
<a name="debian-git" /> <a name="debian-git" />
#### Debian #### Debian
```bash ```bash
sudo apt-get install git sudo apt-get install git
``` ```
<a name="fedora-git" /> <a name="fedora-git" />
#### Fedora #### Fedora
```bash ```bash
sudo dnf install git sudo dnf install git
``` ```
<a name="opensuse-git" /> <a name="opensuse-git" />
#### openSUSE #### openSUSE
```bash ```bash
sudo zypper install git sudo zypper install git
``` ```
<a name="ubuntu-git" /> <a name="ubuntu-git" />
#### Ubuntu #### Ubuntu
```bash ```bash
sudo apt-get install git sudo apt-get install git
``` ```
### Clone qTox ### Clone qTox
Afterwards open a new terminal, change to a directory of your choice and clone Afterwards open a new terminal, change to a directory of your choice and clone
the repository: the repository:
```bash ```bash
cd /home/$USER/qTox cd /home/$USER/qTox
git clone https://github.com/qTox/qTox.git qTox git clone https://github.com/qTox/qTox.git qTox
@ -220,17 +237,22 @@ corresponding parts.
<a name="other-deps" /> <a name="other-deps" />
### GCC, Qt, FFmpeg, OpanAL Soft and qrencode ### GCC, Qt, FFmpeg, OpanAL Soft and qrencode
<a name="arch-other-deps" /> <a name="arch-other-deps" />
#### Arch Linux #### Arch Linux
```bash ```bash
sudo pacman -S --needed base-devel qt5 openal libxss qrencode ffmpeg sudo pacman -S --needed base-devel qt5 openal libxss qrencode ffmpeg
``` ```
<a name="debian-other-deps" /> <a name="debian-other-deps" />
#### Debian #### Debian
**Note that only Debian >=8 stable (jessie) is supported.** **Note that only Debian >=8 stable (jessie) is supported.**
If you use Debian 8, you have to compile FFmpeg manually and add backports to If you use Debian 8, you have to compile FFmpeg manually and add backports to
@ -264,37 +286,64 @@ sudo apt-get install \
<a name="fedora-other-deps" /> <a name="fedora-other-deps" />
#### Fedora #### Fedora
**Note that sqlcipher is not included in all versions of Fedora yet.** **Note that sqlcipher is not included in all versions of Fedora yet.**
As of writing this section (November 2016), Fedora 25 ships sqlcipher, but As of writing this section (November 2016), Fedora 25 ships sqlcipher, but
Fedora 24 and older don't ship it yet. Fedora 24 and older don't ship it yet.
**This means that if you can't install sqlcipher from repositories, you'll **This means that if you can't install sqlcipher from repositories, you'll
have to compile it yourself, otherwise compiling qTox will fail.** have to compile it yourself, otherwise compiling qTox will fail.**
```bash ```bash
sudo dnf groupinstall "Development Tools" "C Development Tools and Libraries" sudo dnf groupinstall "Development Tools" "C Development Tools and Libraries"
# (can also use sudo dnf install @"Development Tools") # (can also use sudo dnf install @"Development Tools")
sudo dnf install qt-devel qt-doc qt-creator qt5-qtsvg qt5-qtsvg-devel \ sudo dnf install \
openal-soft-devel libXScrnSaver-devel qrencode-devel ffmpeg-devel \ ffmpeg-devel \
qtsingleapplication qt5-linguist gtk2-devel libtool openssl-devel gtk2-devel \
``` libXScrnSaver-devel \
```bash libtool \
sudo dnf install sqlcipher sqlcipher-devel openal-soft-devel \
openssl-devel \
qrencode-devel \
qt-creator \
qt-devel \
qt-doc \
qt5-linguist \
qt5-qtsvg \
qt5-qtsvg-devel \
qtsingleapplication \
sqlcipher \
sqlcipher-devel
``` ```
**Go to [sqlcipher](#sqlcipher) section to compile it if necessary.** **Go to [sqlcipher](#sqlcipher) section to compile it if necessary.**
<a name="opensuse-other-deps" /> <a name="opensuse-other-deps" />
#### openSUSE #### openSUSE
```bash ```bash
sudo zypper install patterns-openSUSE-devel_basis libqt5-qtbase-common-devel \ sudo zypper install \
libqt5-qtsvg-devel libqt5-linguist libQt5Network-devel libQt5OpenGL-devel \ libQt5Concurrent-devel \
libQt5Concurrent-devel libQt5Xml-devel libQt5Sql-devel openal-soft-devel \ libQt5Network-devel \
qrencode-devel libXScrnSaver-devel libQt5Sql5-sqlite libffmpeg-devel \ libQt5OpenGL-devel \
libQt5Sql-devel \
libQt5Sql5-sqlite \
libQt5Xml-devel \
libXScrnSaver-devel \
libffmpeg-devel \
libqt5-linguist \
libqt5-qtbase-common-devel \
libqt5-qtsvg-devel \
openal-soft-devel \
patterns-openSUSE-devel_basis \
qrencode-devel \
sqlcipher-devel sqlcipher-devel
``` ```
<a name="slackware-other-deps" /> <a name="slackware-other-deps" />
#### Slackware #### Slackware
List of all the qTox dependencies and their SlackBuilds can be found here: List of all the qTox dependencies and their SlackBuilds can be found here:
@ -302,7 +351,9 @@ http://slackbuilds.org/repository/14.1/network/qTox/
<a name="ubuntu-other-deps" /> <a name="ubuntu-other-deps" />
#### Ubuntu >=15.04 #### Ubuntu >=15.04
```bash ```bash
sudo apt-get install \ sudo apt-get install \
build-essential cmake \ build-essential cmake \
@ -328,7 +379,9 @@ sudo apt-get install \
``` ```
<a name="ubuntu-other-1604-deps" /> <a name="ubuntu-other-1604-deps" />
#### Ubuntu >=16.04: #### Ubuntu >=16.04:
```bash ```bash
sudo apt-get install \ sudo apt-get install \
build-essential \ build-essential \
@ -422,33 +475,42 @@ export PKG_CONFIG_PATH="$PWD/libs/lib/pkgconfig"
Install all of the toxcore dependencies. Install all of the toxcore dependencies.
<a name="arch-toxcore" /> <a name="arch-toxcore" />
#### Arch Linux #### Arch Linux
```bash ```bash
sudo pacman -S --needed opus libvpx libsodium sudo pacman -S --needed opus libvpx libsodium
``` ```
<a name="debian-toxcore" /> <a name="debian-toxcore" />
#### Debian #### Debian
```bash ```bash
sudo apt-get install libtool autotools-dev automake checkinstall check \ sudo apt-get install libtool autotools-dev automake checkinstall check \
libopus-dev libvpx-dev libsodium-dev libavdevice-dev libopus-dev libvpx-dev libsodium-dev libavdevice-dev
``` ```
<a name="fedora-toxcore" /> <a name="fedora-toxcore" />
#### Fedora #### Fedora
```bash ```bash
sudo dnf install libtool autoconf automake check check-devel libsodium-devel \ sudo dnf install libtool autoconf automake check check-devel libsodium-devel \
opus-devel libvpx-devel opus-devel libvpx-devel
``` ```
<a name="opensuse-toxcore" /> <a name="opensuse-toxcore" />
#### openSUSE #### openSUSE
```bash ```bash
sudo zypper install libsodium-devel libvpx-devel libopus-devel \ sudo zypper install libsodium-devel libvpx-devel libopus-devel \
patterns-openSUSE-devel_basis patterns-openSUSE-devel_basis
``` ```
<a name="slackware-toxcore" /> <a name="slackware-toxcore" />
#### Slackware #### Slackware
List of all the toxcore dependencies and their SlackBuilds can be found List of all the toxcore dependencies and their SlackBuilds can be found
@ -456,7 +518,9 @@ here: http://slackbuilds.org/repository/14.1/network/toxcore/
<a name="ubuntu-toxcore" /> <a name="ubuntu-toxcore" />
#### Ubuntu >=15.04 #### Ubuntu >=15.04
```bash ```bash
sudo apt-get install libtool autotools-dev automake checkinstall check \ sudo apt-get install libtool autotools-dev automake checkinstall check \
libopus-dev libvpx-dev libsodium-dev libopus-dev libvpx-dev libsodium-dev
@ -497,11 +561,13 @@ sudo ldconfig
### Compile qTox ### Compile qTox
**Make sure that all the dependencies are installed.** If you experience **Make sure that all the dependencies are installed.** If you experience
problems with compiling, it's most likely due to missing dependencies, so please problems with compiling, it's most likely due to missing dependencies, so please
make sure that you did install *all of them*. make sure that you did install *all of them*.
Run in qTox directory to compile: Run in qTox directory to compile:
```bash ```bash
cmake . cmake .
make make
@ -522,18 +588,21 @@ Congratulations, you've compiled qTox `:)`
#### Debian / Ubuntu / Mint #### Debian / Ubuntu / Mint
If the compiling process stops with a missing dependency like: If the compiling process stops with a missing dependency like:
`... libswscale/swscale.h missing` try: `... libswscale/swscale.h missing` try:
```bash ```bash
apt-file search libswscale/swscale.h apt-file search libswscale/swscale.h
``` ```
And install the package that provides the missing file. And install the package that provides the missing file.
Start make again. Repeat if necessary until all dependencies are installed. If Start make again. Repeat if necessary until all dependencies are installed. If
you can, please note down all additional dependencies you had to install that you can, please note down all additional dependencies you had to install that
aren't listed here, and let us know what is missing `;)` aren't listed here, and let us know what is missing `;)`
==== ---
### Building packages ### Building packages
@ -548,6 +617,7 @@ password for sudo.
<a name="osx" /> <a name="osx" />
## OS X ## OS X
Supported OS X versions: >=10.8. Supported OS X versions: >=10.8.
@ -557,6 +627,7 @@ Compiling qTox on OS X for development requires 3 tools:
[Qt 5.4+](https://www.qt.io/qt5-4/) and [homebrew](https://brew.sh). [Qt 5.4+](https://www.qt.io/qt5-4/) and [homebrew](https://brew.sh).
### Automated Script ### Automated Script
You can now set up your OS X system to compile qTox automatically thanks to the You can now set up your OS X system to compile qTox automatically thanks to the
script in: `./osx/qTox-Mac-Deployer-ULTIMATE.sh` script in: `./osx/qTox-Mac-Deployer-ULTIMATE.sh`
@ -572,6 +643,7 @@ Note that the script will revert any non-committed changes to qTox repository
during the `update` phase. during the `update` phase.
#### First Run / Install #### First Run / Install
If you are running the script for the first time you will want to make sure your If you are running the script for the first time you will want to make sure your
system is ready. To do this simply run `./qTox-Mac-Deployer-ULTIMATE.sh -i` to system is ready. To do this simply run `./qTox-Mac-Deployer-ULTIMATE.sh -i` to
run you through the automated install set up. run you through the automated install set up.
@ -583,6 +655,7 @@ If there aren't any errors then you'll find a locally working qTox application
in your home folder under `~/qTox-Mac_Build` in your home folder under `~/qTox-Mac_Build`
#### Updating #### Updating
If you want to update your application for testing purposes or you want to run a If you want to update your application for testing purposes or you want to run a
nightly build setup then run: `./qTox-Mac-Deployer-ULTIMATE.sh -u` and follow nightly build setup then run: `./qTox-Mac-Deployer-ULTIMATE.sh -u` and follow
the prompts. (NOTE: If you know you updated the repos before running this hit Y) the prompts. (NOTE: If you know you updated the repos before running this hit Y)
@ -590,6 +663,7 @@ followed by `./qTox-Mac-Deployer-ULTIMATE.sh -b` to build the application once
more. (NOTE: This will delete your previous build.) more. (NOTE: This will delete your previous build.)
#### Deploying #### Deploying
OS X requires an extra step to make the `qTox.app` file shareable on a system OS X requires an extra step to make the `qTox.app` file shareable on a system
that doesn't have the required libraries installed already. that doesn't have the required libraries installed already.
@ -598,12 +672,15 @@ then simply run: `./qTox-Mac-Deployer-ULTIMATE.sh -d`
### Manual Compiling ### Manual Compiling
#### Required Libraries #### Required Libraries
Install homebrew if you don't have it: Install homebrew if you don't have it:
```bash ```bash
ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)" ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
``` ```
First, let's install the dependencies available via `brew`. First, let's install the dependencies available via `brew`.
```bash ```bash
brew install git ffmpeg qrencode libtool automake autoconf check qt5 libvpx \ brew install git ffmpeg qrencode libtool automake autoconf check qt5 libvpx \
opus sqlcipher libsodium opus sqlcipher libsodium
@ -613,29 +690,34 @@ Next, install
[toxcore](https://github.com/toktok/c-toxcore/blob/master/INSTALL.md#osx) [toxcore](https://github.com/toktok/c-toxcore/blob/master/INSTALL.md#osx)
Then, clone qTox: Then, clone qTox:
```bash ```bash
git clone https://github.com/qTox/qTox git clone https://github.com/qTox/qTox
``` ```
Finally, copy all required files. Whenever you update your brew packages, you Finally, copy all required files. Whenever you update your brew packages, you
may skip all of the above steps and simply run the following commands: may skip all of the above steps and simply run the following commands:
```bash ```bash
cd ./git/qTox cd ./git/qTox
sudo bash bootstrap-osx.sh sudo bash bootstrap-osx.sh
``` ```
#### Compiling #### Compiling
You can build qTox with Qt Creator You can build qTox with Qt Creator
[seperate download](http://www.qt.io/download-open-source/#section-6) or [seperate download](http://www.qt.io/download-open-source/#section-6) or
manually with cmake manually with cmake
With that; in your terminal you can compile qTox in the git dir: With that; in your terminal you can compile qTox in the git dir:
```bash ```bash
cmake . cmake .
make make
``` ```
Or a cleaner method would be to: Or a cleaner method would be to:
```bash ```bash
cd ./git/dir/qTox cd ./git/dir/qTox
mkdir ./build mkdir ./build
@ -644,24 +726,30 @@ cmake ..
``` ```
#### Deploying #### Deploying
If you compiled qTox properly you can now deploy the `qTox.app` that's created If you compiled qTox properly you can now deploy the `qTox.app` that's created
where you built qTox so you can distribute the package. where you built qTox so you can distribute the package.
Using your qt5 homebrew installation from the build directory: Using your qt5 homebrew installation from the build directory:
```bash ```bash
/usr/local/Cellar/qt5/5.5.1_2/bin/macdeployqt ./qTox.app /usr/local/Cellar/qt5/5.5.1_2/bin/macdeployqt ./qTox.app
``` ```
#### Running qTox #### Running qTox
You've got 2 choices, either click on the qTox app that suddenly exists, or do You've got 2 choices, either click on the qTox app that suddenly exists, or do
the following: the following:
```bash ```bash
qtox.app/Contents/MacOS/qtox qtox.app/Contents/MacOS/qtox
``` ```
Enjoy the snazzy CLI output as your friends and family congratulate you on Enjoy the snazzy CLI output as your friends and family congratulate you on
becoming a hacker becoming a hacker
<a name="windows" /> <a name="windows" />
## Windows ## Windows
### Qt ### Qt
@ -724,6 +812,7 @@ following steps assume that you cloned the repository at `C:\qTox`. If you
decided to choose another location, replace corresponding parts. decided to choose another location, replace corresponding parts.
### Getting dependencies ### Getting dependencies
Run `bootstrap.bat` in cloned `C:\qTox` directory. Script will download rest of Run `bootstrap.bat` in cloned `C:\qTox` directory. Script will download rest of
dependencies compile them and put to appropriate directories. dependencies compile them and put to appropriate directories.