StarMirror/toxcore
1
0
Fork 0
mirror of https://github.com/irungentoo/toxcore.git synced 2024-03-22 13:30:51 +08:00
Code Issues Projects Releases Wiki Activity

Merge pull request #521 from stqism/docs

Browse Source 
Updated the INSTALL.md to reflect the new build system
This commit is contained in:
irungentoo 2013-08-24 04:56:22 -07:00
commit dc0bc49960
1 changed files with 56 additions and 51 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

107
INSTALL.md
View File

@ -16,14 +16,14 @@
Build dependencies:
```bash
apt-get install build-essential libtool autotools-dev automake libconfig-dev ncurses-dev cmake checkinstall check
apt-get install build-essential libtool autotools-dev automake libconfig-dev ncurses-dev checkinstall check
```
On Fedora:
```bash
yum groupinstall "Development Tools"
yum install libtool autoconf automake libconfig-devel ncurses-devel cmake check check-devel
yum install libtool autoconf automake libconfig-devel ncurses-devel check check-devel
```
Note that `libconfig-dev` should be >= 1.4.
@ -59,28 +59,18 @@ Then clone this repo and generate makefile:
```bash
git clone git://github.com/irungentoo/ProjectTox-Core.git
cd ProjectTox-Core
mkdir build && cd build
cmake ..
```
Advance cmake options:
- `-DUSE_NACL=ON` (default `OFF`) <20> Use NaCl library instead of libsodium.
Note that you should call cmake on the root [`CMakeLists.txt`](/CMakeLists.txt) file only.
Then you can build any of the [`/testing`](/testing) and [`/other`](/other) that are currently supported on your platform by running:
```bash
make name_of_c_file
```
For example, to build [`Messenger_test.c`](/others/Messenger_test.c) you would run:
```bash
make Messenger_test
```
Or you could just build everything that is supported on your platform by running:
```bash
autoreconf -i
./configure
make
make install
```
Advance configure options:
- --prefix=/where/to/install
- --with-libsodium-headers=/path/to/libsodium/include/
- --with-libsodium-libs=/path/to/sodiumtest/lib/
- --BUILD_DHT_BOOTSTRAP_DAEMON="yes"
- --BUILD_NTOX="yes"
- --BUILD_TESTS="yes"
<a name="osx" />
###OS X:
@ -88,14 +78,27 @@ You need the latest XCode with the Developer Tools (Preferences -> Downloads ->
The 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.
There 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.
<a name="homebrew" />
####Homebrew:
```
brew install libtool automake autoconf libconfig libsodium cmake check
cmake .
make
brew install libtool automake autoconf libconfig libsodium check
```
Then clone this repo and generate makefile:
```bash
git clone git://github.com/irungentoo/ProjectTox-Core.git
cd ProjectTox-Core
autoreconf -i
./configure
make
make install
```
Advance configure options:
- --prefix=/where/to/install
- --with-libsodium-headers=/path/to/libsodium/include/
- --with-libsodium-libs=/path/to/sodiumtest/lib/
- --BUILD_DHT_BOOTSTRAP_DAEMON="yes"
- --BUILD_NTOX="yes"
- --BUILD_TESTS="yes"
<a name="non-homebrew" />
####Non-homebrew:
@ -119,10 +122,22 @@ sudo make install
In your local TOX repository:
Then generate the makefile:
```bash
cmake .
cd ProjectTox-Core
autoreconf -i
./configure
make
make install
```
Advance configure options:
- --prefix=/where/to/install
- --with-libsodium-headers=/path/to/libsodium/include/
- --with-libsodium-libs=/path/to/sodiumtest/lib/
- --BUILD_DHT_BOOTSTRAP_DAEMON="yes"
- --BUILD_NTOX="yes"
- --BUILD_TESTS="yes"
Do not install them from macports (or any dependencies for that matter) as they get shoved in the wrong directory
(or the wrong version gets installed) and make your life more annoying.
@ -136,7 +151,6 @@ http://caiustheory.com/install-gcc-421-apple-build-56663-with-xcode-42
You should install:
- [MinGW](http://sourceforge.net/projects/mingw/)'s C compiler
- [CMake](http://www.cmake.org/cmake/resources/software.html)
- [check] (http://check.sourceforge.net/)
You have to [modify your PATH environment variable](http://www.computerhope.com/issues/ch000549.htm) so that it contains MinGW's bin folder path. With default settings, the bin folder is located at `C:\MinGW\bin`, which means that you would have to append `;C:\MinGW\bin` to the PATH variable.
@ -145,28 +159,19 @@ Then you should either clone this repo by using git, or just download a [zip of
After that you should get precompiled package of libsodium from [here](https://download.libsodium.org/libsodium/releases/libsodium-win32-0.4.2.tar.gz) and extract the archive into this repo's root. That is, `sodium` folder should be along with `core`, `testing` and other folders.
Navigate in `cmd` to this repo and run:
Then clone this repo and generate makefile:
```cmd
mkdir build && cd build
cmake -G "MinGW Makefiles" ..
git clone git://github.com/irungentoo/ProjectTox-Core.git
cd ProjectTox-Core
autoreconf -i
./configure
make
make install
```
Advance cmake options:
- `-DSHARED_TOXCORE=ON` (default OFF) <20> Build Core as a shared library.
- `-DSHARED_LIBSODIUM=ON` (default OFF) <20> Link libsodium as a shared library.
Note that you should call cmake on the root [`CMakeLists.txt`](/CMakeLists.txt) file only.
Then you can build any of the [`/testing`](/testing) and [`/other`](/other) that are currently supported on your platform by running:
```cmd
mingw32-make name_of_c_file
```
For example, to build [`Messenger_test.c`](/others/Messenger_test.c) you would run:
```cmd
mingw32-make Messenger_test
```
Or you could just build everything that is supported on your platform by running:
```bash
mingw32-make
```
Advance configure options:
- --prefix=/where/to/install
- --with-libsodium-headers=/path/to/libsodium/include/
- --with-libsodium-libs=/path/to/sodiumtest/lib/
- --BUILD_DHT_BOOTSTRAP_DAEMON="yes"
- --BUILD_NTOX="yes"
- --BUILD_TESTS="yes"