summaryrefslogtreecommitdiff
path: root/INSTALL.md
diff options
context:
space:
mode:
Diffstat (limited to 'INSTALL.md')
-rw-r--r--INSTALL.md52
1 files changed, 52 insertions, 0 deletions
diff --git a/INSTALL.md b/INSTALL.md
new file mode 100644
index 00000000..b4e28379
--- /dev/null
+++ b/INSTALL.md
@@ -0,0 +1,52 @@
1##Installation
2
3###Linux:
4
5You should get and install [libsodium](https://github.com/jedisct1/libsodium):
6```bash
7git clone git://github.com/jedisct1/libsodium.git
8cd libsodium
9git checkout tags/0.4.2
10./autogen.sh
11./configure && make check
12sudo make install
13sudo ldconfig
14```
15
16Then clone this repo and run:
17```bash
18cmake CMakeLists.txt
19```
20
21Then you can build any of the [`/testing`](/testing) and [`/other`](/other) by running:
22```bash
23make name_of_c_file
24```
25For example, to build [`Messenger_test.c`](/others/Messenger_test.c) you would run:
26```bash
27make Messenger_test
28```
29
30###Windows:
31
32You should install:
33 - [MinGW](http://sourceforge.net/projects/mingw/)'s C compiler
34 - [CMake](http://www.cmake.org/cmake/resources/software.html)
35
36Then you should either clone this repo by using git, or just download a [zip of current Master branch](https://github.com/irungentoo/ProjectTox-Core/archive/master.zip) and extract it somewhere.
37
38After that you should get precompiled packages of libsodium from [here](https://download.libsodium.org/libsodium/releases/) and extract the archive into this repo's root. That is, `sodium` folder should be along with `core`, `testing` and other folders.
39
40Navigate in `cmd` to this repo and run:
41```cmd
42cmake -G "MinGW Makefiles" CMakeLists.txt
43```
44
45Then you can build any of the [`/testing`](/testing) and [`/other`](/other) by running:
46```cmd
47mingw32-make name_of_c_file
48```
49For example, to build [`Messenger_test.c`](/others/Messenger_test.c) you would run:
50```cmd
51mingw32-make Messenger_test
52``` \ No newline at end of file