StarMirror/qTox
1
0
Fork 0
mirror of https://github.com/qTox/qTox.git synced 2024-03-22 14:00:36 +08:00
Code Issues Projects Releases Wiki Activity

style(INSTALL.md): improve Markdown formatting and grammar

Browse Source
This commit is contained in:
kehugter 2016-04-10 00:26:26 +02:00
parent f82a74a4bc
commit e6242232ab
1 changed files with 61 additions and 59 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

120
INSTALL.md
View File

@ -1,4 +1,4 @@
#Install Instructions
# Install Instructions
- [Dependencies](#dependencies)
- [Linux](#linux)
- [Simple install](#simple-install)
@ -30,7 +30,7 @@
- [Ubuntu >=15.04](#ubuntu-toxcore)
- [filter_audio](#filter_audio)
- [sqlcipher](#sqlcipher)
- [toxcore compiling](#toxcore-compiling)
- [Compile toxcore](#compile-toxcore)
- [Compile qTox](#compile-qtox)
- [OS X](#osx)
- [Windows](#windows)
@ -125,19 +125,19 @@ In order to clone the qTox repository you need Git.
<a name="arch-git" />
#### Arch Linux:
#### Arch Linux
```bash
sudo pacman -S --needed git
```
<a name="debian-git" />
#### Debian:
#### Debian
```bash
sudo apt-get install git
```
<a name="fedora-git" />
#### Fedora:
#### Fedora
*`yum` is now officially deprecated by `dnf`. using `yum` will redirect to `dnf`
on Fedora 21 and fail on future versions.*
```bash
@ -145,27 +145,27 @@ sudo dnf install git
```
<a name="opensuse-git" />
#### openSUSE:
#### openSUSE
```bash
sudo zypper install git
```
<a name="ubuntu-git" />
#### Ubuntu:
#### Ubuntu
```bash
sudo apt-get install git
```
### 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:
```bash
cd /home/user/qTox
git clone https://github.com/tux3/qTox.git qTox
```
The following steps assumes that you cloned the repository at "/home/user/qTox".
The following steps assumes that you cloned the repository at `/home/user/qTox`.
If you decided to choose another location, replace corresponding parts.
@ -173,14 +173,14 @@ If you decided to choose another location, replace corresponding parts.
### GCC, Qt, FFmpeg, OpanAL Soft and qrencode
<a name="arch-other-deps" />
#### Arch Linux:
#### Arch Linux
```bash
sudo pacman -S --needed base-devel qt5 openal libxss qrencode ffmpeg
```
<a name="debian-other-deps" />
#### Debian:
#### Debian
**Note that only Debian >=8 stable (jessie) is supported.**
If you use stable, you have to add backports to your `sources.list` for FFmpeg
@ -195,7 +195,7 @@ libsqlcipher-dev
<a name="fedora-other-deps" />
#### Fedora:
#### Fedora
**Note that sqlcipher is not included in Fedora(!).**
**This means that you have to compile sqlcipher yourself, otherwise compiling
@ -211,7 +211,7 @@ qtsingleapplication qt5-linguist gtk2-devel
**Go to [sqlcipher](#sqlcipher) section to compile it.**
<a name="opensuse-other-deps" />
#### openSUSE:
#### openSUSE
```bash
sudo zypper install patterns-openSUSE-devel_basis libqt5-qtbase-common-devel \
@ -222,14 +222,14 @@ sqlcipher-devel
```
<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:
http://slackbuilds.org/repository/14.1/network/qTox/
<a name="ubuntu-other-deps" />
#### Ubuntu >=15.04:
#### Ubuntu >=15.04
```bash
sudo apt-get install build-essential qt5-qmake qt5-default qttools5-dev-tools \
libqt5opengl5-dev libqt5svg5-dev libopenal-dev libxss-dev qrencode \
@ -245,41 +245,41 @@ libsqlcipher-dev
Install all of the toxcore dependencies.
<a name="arch-toxcore" />
#### Arch Linux:
#### Arch Linux
```bash
sudo pacman -S --needed opus libvpx libsodium
```
<a name="debian-toxcore" />
#### Debian:
#### Debian
```bash
sudo apt-get install libtool autotools-dev automake checkinstall check \
libopus-dev libvpx-dev libsodium-dev libavdevice-dev
```
<a name="fedora-toxcore" />
#### Fedora:
#### Fedora
```bash
sudo dnf install libtool autoconf automake check check-devel libsodium-devel \
opus-devel libvpx-devel
```
<a name="opensuse-toxcore" />
#### openSUSE:
#### openSUSE
```bash
sudo zypper install libsodium-devel libvpx-devel libopus-devel \
patterns-openSUSE-devel_basis
```
<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
here: http://slackbuilds.org/repository/14.1/network/toxcore/
<a name="ubuntu-toxcore" />
#### Ubuntu >=15.04:
#### Ubuntu >=15.04
```bash
sudo apt-get install libtool autotools-dev automake checkinstall check \
libopus-dev libvpx-dev libsodium-dev
@ -287,7 +287,7 @@ libopus-dev libvpx-dev libsodium-dev
### filter_audio
This step is best done before compiling `toxcore`.
This step is best done before compiling toxcore.
Now you can either follow the instructions at
https://github.com/irungentoo/toxcore/blob/master/INSTALL.md#unix or use the
@ -324,9 +324,11 @@ make -j$(nproc)
sudo make install
cd ..
```
If you wish to explictly link sqlcipher statically or dynamically use:
If you wish to explicitly link sqlcipher
[statically](#statically-linked-sqlcipher) or
[dynamically](#dynamically-linked-sqlcipher).
#### Statically linked:
#### Statically linked sqlcipher
```
git clone https://github.com/sqlcipher/sqlcipher
cd sqlpcipher
@ -337,7 +339,7 @@ sudo make install
cd ..
```
#### Dynamically linked:
#### Dynamically linked sqlcipher
```
git clone https://github.com/sqlcipher/sqlcipher
cd sqlcipher
@ -348,7 +350,7 @@ sudo make install
cd ..
```
### toxcore compiling
### Compile toxcore
Provided that you have all required dependencies installed, you can simply run:
```bash
@ -379,11 +381,11 @@ Now you can start compiled qTox with `./qtox`
Congratulations, you've compiled qTox `:)`
#### openSUSE / Fedora:
#### openSUSE / Fedora
Note to Fedora users: check qt5 version before building default is 4.8 on fedora
21 / 22, everything up until qmake-qt5 will build fine but then qmake-qt5 will
freak out.
21 / 22, everything up until `qmake-qt5` will build fine but then `qmake-qt5`
will freak out.
```bash
qmake-qt5
make
@ -396,7 +398,7 @@ If the compiling process stops with a missing dependency like:
apt-file search libswscale/swscale.h
```
And install the package that provides the missing file.
Start make again. Repeat if nessary 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
aren't listed here, and let us know what is missing `;)`
@ -406,21 +408,21 @@ aren't listed here, and let us know what is missing `;)`
### Building packages
Alternately, qTox now has the experimental and probably-dodgy ability to package
itself (in .deb form natively, and .rpm form with
<a href="http://joeyh.name/code/alien/">alien</a>).
itself (in `.deb` form natively, and `.rpm` form with
[alien](http://joeyh.name/code/alien/)).
After installing the required dependencies, run `bootstrap.sh` and then run the
`buildPackages.sh` script, found in the tools folder. It will automatically get
the packages necessary for building .debs, so be prepared to type your password
for sudo.
the packages necessary for building `.deb`s, so be prepared to type your
password for sudo.
<a name="osx" />
## OS X
Compiling qTox on OS X for development requires 3 tools,
[Xcode](https://developer.apple.com/xcode/) and
[Qt 5.4+](http://www.qt.io/qt5-4/), and [homebrew](http://brew.sh).
Compiling qTox on OS X for development requires 3 tools:
[Xcode](https://developer.apple.com/xcode/),
[Qt 5.4+](http://www.qt.io/qt5-4/) and [homebrew](http://brew.sh).
### Automated Script
You can now set up your OS X system to compile qTox automatically thanks to the
@ -435,7 +437,7 @@ To use this script you must launch terminal which can be found:
If you wish to lean more you can run `./qTox-Mac-Deployer-ULTIMATE.sh -h`
#### First Run / Install
If you are running the script for the first time you will want to makesure 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
run you through the automated install set up.
@ -466,7 +468,7 @@ Install homebrew if you don't have it:
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
brew install git ffmpeg qrencode libtool automake autoconf check qt5 libvpx \
opus sqlcipher libsodium
@ -482,7 +484,7 @@ cd ../
```
Next, install
[Toxcore](https://github.com/irungentoo/toxcore/blob/master/INSTALL.md#osx)
[toxcore](https://github.com/irungentoo/toxcore/blob/master/INSTALL.md#osx)
Then, clone qTox:
```bash
@ -532,8 +534,8 @@ the following:
```bash
qtox.app/Contents/MacOS/qtox
```
* Enjoy the snazzy CLI output as your friends and family congratulate you on
becoming a hacker
Enjoy the snazzy CLI output as your friends and family congratulate you on
becoming a hacker
<a name="windows" />
## Windows
@ -546,34 +548,34 @@ to assemble your Qt toolchain. Take the most recent version of Qt compiled with
MinGW. Although the installer provides its own bundled MinGW compiler toolchain
its recommend installing it separately because Qt is missing MSYS which is
needed to compile and install OpenCV and OpenAL. Thus you can - if needed -
deselect the tab "Tools". The following steps assume that Qt is installed at
"C:\Qt". If you decided to choose another location, replace corresponding parts.
deselect the tab `Tools`. The following steps assume that Qt is installed at
`C:\Qt`. If you decided to choose another location, replace corresponding parts.
### MinGW
Download the MinGW installer for Windows from
[sourceforge.net](http://sourceforge.net/projects/mingw/files/Installer/). Make
sure to install MSYS (a set of Unix tools for Windows). The following steps
assume that MinGW is installed at "C:\MinGW". If you decided to choose another
assume that MinGW is installed at `C:\MinGW`. If you decided to choose another
location, replace corresponding parts. Check that the version of MinGW,
corresponds to the version of the QT component!
### WGet
Download the WGet installer for Windows from
### Wget
Download the Wget installer for Windows from
http://gnuwin32.sourceforge.net/packages/wget.htm. Install them. The following
steps assume that WGet is installed at "C:\Program Files\GnuWin32\". If you
steps assume that Wget is installed at `C:\Program Files\GnuWin32\`. If you
decided to choose another location, replace corresponding parts.
### Setting up Path
Add MinGW/MSYS/CMake binaries to the system path to make them globally
accessible. Open Control Panel -> System and Security -> System ->
Advanced system settings -> Environment Variables...(or run "sysdm.cpl" select
tab "Advanced system settings" -> button "Environment Variables"). In the second
box search for the PATH variable and press Edit... The input box
"Variable value:" should already contain some directories. Each directory is
accessible. Open `Control Panel` -> `System and Security` -> `System` ->
`Advanced system settings` -> `Environment Variables...` (or run `sysdm.cpl`
select tab `Advanced system settings` -> button `Environment Variables`). In the
second box search for the `PATH` variable and press `Edit...`. The input box
`Variable value:` should already contain some directories. Each directory is
separated with a semicolon. Extend the input box by adding
";C:\MinGW\bin;C:\MinGW\msys\1.0\bin;C:\Program Files (x86)\CMake 2.8\bin;C:\Program Files\GnuWin32\bin".
`;C:\MinGW\bin;C:\MinGW\msys\1.0\bin;C:\Program Files (x86)\CMake 2.8\bin;C:\Program Files\GnuWin32\bin`.
The very first semicolon must only be added if it is missing. CMake may be added
by installer automatically.
@ -581,10 +583,10 @@ by installer automatically.
Clone the repository (https://github.com/tux3/qTox.git) with your preferred Git
client. [SmartGit](http://www.syntevo.com/smartgit/) is very nice for this task
(you may need to add the path to the git.exe system variable Path). The
following steps assume that you cloned the repository at "C:\qTox". If you
(you may need to add the path to the `git.exe` system variable Path). The
following steps assume that you cloned the repository at `C:\qTox`. If you
decided to choose another location, replace corresponding parts.
### 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.