summaryrefslogtreecommitdiff
path: root/INSTALL.md
diff options
context:
space:
mode:
authorMaxim Biro <nurupo.contributions@gmail.com>2017-04-12 08:07:06 -0400
committerMaxim Biro <nurupo.contributions@gmail.com>2017-04-19 20:22:28 -0400
commitf6285d7a60a75773f91754d5f254192139b5ceb8 (patch)
tree843701b69e8108b47968de52e2f36d695e3840ea /INSTALL.md
parent439f676d45d75f59f47a000a6adca8e9fe6a6e4e (diff)
Fix markdown formatting
Diffstat (limited to 'INSTALL.md')
-rw-r--r--INSTALL.md91
1 files changed, 32 insertions, 59 deletions
diff --git a/INSTALL.md b/INSTALL.md
index d4e648ef..abd7e6cf 100644
--- a/INSTALL.md
+++ b/INSTALL.md
@@ -1,31 +1,29 @@
1#Install Instructions 1# Install Instructions
2 2
3- [Installation](#installation) 3- [Installation](#installation)
4 - [Unix like](#unix) 4 - [Unix like](#most-unix-like-oses)
5 - [Quick install](#quick-install) 5 - [Quick install](#quick-install)
6 - [Build manually](#build-manually) 6 - [Build manually](#build-manually)
7 - [Compile toxcore](#compile-toxcore) 7 - [Compile toxcore](#compile-toxcore)
8 - [OS X](#osx) 8 - [OS X](#os-x)
9 - [Homebrew](#homebrew) 9 - [Homebrew](#homebrew)
10 - [Non-Homebrew](#non-homebrew) 10 - [Non-Homebrew](#non-homebrew)
11 - [Windows](#windows) 11 - [Windows](#windows)
12 - [Cross-Compile](#windows-cross-compile) 12 - [Cross-Compile](#cross-compile)
13 - [Setting up a VM](#windows-cross-compile-vm) 13 - [Setting up a VM](#setting-up-a-vm)
14 - [Setting up the environment](#windows-cross-compile-environment) 14 - [Setting up the environment](#setting-up-the-environment)
15 - [Compiling](#windows-cross-compile-compiling) 15 - [Compiling](#compiling)
16 - [Native](#windows-native) 16 - [Native](#native)
17- [Additional](#additional) 17- [Additional](#additional)
18 - [Advanced configure options](#aconf) 18 - [Advanced configure options](#advanced-configure-options)
19 - [A/V support](#av) 19 - [A/V support](#av-support)
20 - [libtoxav](#libtoxav) 20 - [libtoxav](#libtoxav)
21 - [Bootstrap daemon](#bootstrapd) 21 - [Bootstrap daemon](#bootstrap-daemon)
22 - [nTox](#ntox) 22 - [nTox](#ntox-test-cli)
23 23
24<a name="installation" /> 24## Installation
25##Installation
26 25
27<a name="unix" /> 26### Most Unix like OSes:
28###Most Unix like OSes:
29 27
30#### Quick install: 28#### Quick install:
31 29
@@ -131,17 +129,16 @@ sudo make install
131``` 129```
132 130
133 131
134<a name="osx" /> 132### OS X:
135###OS X:
136 133
137You need the latest XCode with the Developer Tools (Preferences -> Downloads -> Command Line Tools). 134You need the latest XCode with the Developer Tools (Preferences -> Downloads -> Command Line Tools).
138The following libraries are required along with libsodium and cmake for Mountain Lion and XCode 4.6.3 install libtool, automake and autoconf. You can download them with Homebrew, or install them manually. 135The following libraries are required along with libsodium and cmake for Mountain Lion and XCode 4.6.3 install libtool, automake and autoconf. You can download them with Homebrew, or install them manually.
139 136
140**Note: OS X users can also install Toxcore using [osx_build_script_toxcore.sh](other/osx_build_script_toxcore.sh)** 137**Note: OS X users can also install Toxcore using [osx_build_script_toxcore.sh](other/osx_build_script_toxcore.sh)**
141 138
142There are no binaries/executables going to /bin/ or /usr/bin/ now. Everything is compiled and ran from the inside your local branch. See [Usage](#usage) below. 139There are no binaries/executables going to /bin/ or /usr/bin/ now. Everything is compiled and ran from the inside your local branch.
143<a name="homebrew" /> 140
144####Homebrew: 141#### Homebrew:
145To install from the formula: 142To install from the formula:
146```bash 143```bash
147brew tap Tox/tox 144brew tap Tox/tox
@@ -177,8 +174,7 @@ make install
177``` 174```
178 175
179 176
180<a name="non-homebrew" /> 177#### Non-homebrew:
181####Non-homebrew:
182 178
183Grab the following packages: 179Grab the following packages:
184 * https://gnu.org/software/libtool/ 180 * https://gnu.org/software/libtool/
@@ -267,17 +263,13 @@ If there is a problem with opus (for A/V) and you don't get a libtoxav, then try
267export PKG_CONFIG_PATH=/usr/local/lib/pkgconfig 263export PKG_CONFIG_PATH=/usr/local/lib/pkgconfig
268``` 264```
269 265
270<a name="windows" /> 266### Windows:
271###Windows:
272
273<a name="windows-cross-compile" />
274 267
275####Cross-compile 268#### Cross-compile
276 269
277It's a bit challenging to build Tox and all of its dependencies nativly on Windows, so we will show an easier, less error and headache prone method of building it -- cross-compiling. 270It's a bit challenging to build Tox and all of its dependencies nativly on Windows, so we will show an easier, less error and headache prone method of building it -- cross-compiling.
278 271
279<a name="windows-cross-compile-vm" /> 272##### Setting up a VM
280#####Setting up a VM
281 273
282We will assume that you don't have any VM running Linux around and will guide you from the ground up. 274We will assume that you don't have any VM running Linux around and will guide you from the ground up.
283 275
@@ -324,8 +316,7 @@ After the system is booted, go to **Devices** -> **Shared Clipboard** and select
324 316
325Now that the virtual machine is all set up, let's move to getting build dependencies and setting up environment variables. 317Now that the virtual machine is all set up, let's move to getting build dependencies and setting up environment variables.
326 318
327<a name="windows-cross-compile-environment" /> 319##### Setting up the environment
328#####Setting up the environment
329 320
330First we will install all tools that we would need for building: 321First we will install all tools that we would need for building:
331```bash 322```bash
@@ -365,8 +356,7 @@ mkdir build
365cd build 356cd build
366``` 357```
367 358
368<a name="windows-cross-compile-compiling" /> 359##### Compiling
369#####Compiling
370 360
371Now we will build libraries needed for audio/video: VPX and Opus. 361Now we will build libraries needed for audio/video: VPX and Opus.
372 362
@@ -439,8 +429,7 @@ cp -r ../include/tox /media/sf_toxbuild/release/include
439 429
440That's it. Now you should have `release/bin/libtox.dll`, `release/bin/libtox.dll.a` and `release/include/tox/<headers>` in your `toxbuild` directory on the Windows system. 430That's it. Now you should have `release/bin/libtox.dll`, `release/bin/libtox.dll.a` and `release/include/tox/<headers>` in your `toxbuild` directory on the Windows system.
441 431
442<a name="windows-native" /> 432#### Native
443####Native
444 433
445Note that the Native instructions are incomplete, in a sense that they miss instructions needed for adding audio/video support to Tox. You also might stumble upon some unknown MinGW+msys issues while trying to build it. 434Note that the Native instructions are incomplete, in a sense that they miss instructions needed for adding audio/video support to Tox. You also might stumble upon some unknown MinGW+msys issues while trying to build it.
446 435
@@ -475,21 +464,10 @@ make
475make install 464make install
476``` 465```
477 466
478<a name="Clients" />
479####Clients:
480While [Toxic](https://github.com/tox/toxic) is no longer in core, a list of Tox clients are located in our [wiki](https://wiki.tox.chat/doku.php?id=clients)
481
482
483
484 467
468## Additional
485 469
486<a name="additional" /> 470### Advanced configure options:
487##Additional
488
489
490
491<a name="aconf" />
492###Advanced configure options:
493 471
494 - --prefix=/where/to/install 472 - --prefix=/where/to/install
495 - --with-libsodium-headers=/path/to/libsodium/include/ 473 - --with-libsodium-headers=/path/to/libsodium/include/
@@ -499,17 +477,14 @@ While [Toxic](https://github.com/tox/toxic) is no longer in core, a list of Tox
499 - --disable-tests build unit tests (default: auto) 477 - --disable-tests build unit tests (default: auto)
500 - --disable-av disable A/V support (default: auto) see: [libtoxav](#libtoxav) 478 - --disable-av disable A/V support (default: auto) see: [libtoxav](#libtoxav)
501 - --enable-ntox build nTox client (default: no) see: [nTox](#ntox) 479 - --enable-ntox build nTox client (default: no) see: [nTox](#ntox)
502 - --enable-daemon build DHT bootstrap daemon (default=no) see: [Bootstrap daemon](#bootstrapd) 480 - --enable-daemon build DHT bootstrap daemon (default=no) see: [Bootstrap daemon](#bootstrap-daemon)
503 - --enable-dht-bootstrap build DHT bootstrap utility (default=disabled) 481 - --enable-dht-bootstrap build DHT bootstrap utility (default=disabled)
504 - --enable-shared[=PKGS] build shared libraries [default=yes] 482 - --enable-shared[=PKGS] build shared libraries [default=yes]
505 - --enable-static[=PKGS] build static libraries [default=yes] 483 - --enable-static[=PKGS] build static libraries [default=yes]
506 484
485### A/V support:
507 486
508<a name="av" /> 487#### libtoxav:
509###A/V support:
510
511<a name="libtoxav" />
512####libtoxav:
513 488
514'libtoxav' is needed for A/V support and it's enabled by default. You can disable it by adding --disable-av argument to ./configure script like so: 489'libtoxav' is needed for A/V support and it's enabled by default. You can disable it by adding --disable-av argument to ./configure script like so:
515```bash 490```bash
@@ -555,8 +530,7 @@ sudo make install
555cd .. 530cd ..
556``` 531```
557 532
558<a name="bootstrapd" /> 533### Bootstrap daemon:
559###Bootstrap daemon:
560 534
561Daemon is disabled by default. You can enable it by adding --enable-daemon argument to ./configure script like so: 535Daemon is disabled by default. You can enable it by adding --enable-daemon argument to ./configure script like so:
562```bash 536```bash
@@ -584,8 +558,7 @@ Grab the following [package](http://www.hyperrealm.com/libconfig/), uncompress a
584See this [readme](other/bootstrap_daemon/README.md) on how to set up the bootstrap daemon. 558See this [readme](other/bootstrap_daemon/README.md) on how to set up the bootstrap daemon.
585 559
586 560
587<a name="ntox" /> 561### nTox test cli:
588###nTox test cli:
589 562
590nTox is disabled by default. You can enable it by adding --enable-ntox argument to ./configure script like so: 563nTox is disabled by default. You can enable it by adding --enable-ntox argument to ./configure script like so:
591```bash 564```bash