diff options
-rw-r--r-- | INSTALL.md | 52 | ||||
-rw-r--r-- | docs/TODO.txt | 4 |
2 files changed, 55 insertions, 1 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 | |||
5 | You should get and install [libsodium](https://github.com/jedisct1/libsodium): | ||
6 | ```bash | ||
7 | git clone git://github.com/jedisct1/libsodium.git | ||
8 | cd libsodium | ||
9 | git checkout tags/0.4.2 | ||
10 | ./autogen.sh | ||
11 | ./configure && make check | ||
12 | sudo make install | ||
13 | sudo ldconfig | ||
14 | ``` | ||
15 | |||
16 | Then clone this repo and run: | ||
17 | ```bash | ||
18 | cmake CMakeLists.txt | ||
19 | ``` | ||
20 | |||
21 | Then you can build any of the [`/testing`](/testing) and [`/other`](/other) by running: | ||
22 | ```bash | ||
23 | make name_of_c_file | ||
24 | ``` | ||
25 | For example, to build [`Messenger_test.c`](/others/Messenger_test.c) you would run: | ||
26 | ```bash | ||
27 | make Messenger_test | ||
28 | ``` | ||
29 | |||
30 | ###Windows: | ||
31 | |||
32 | You should install: | ||
33 | - [MinGW](http://sourceforge.net/projects/mingw/)'s C compiler | ||
34 | - [CMake](http://www.cmake.org/cmake/resources/software.html) | ||
35 | |||
36 | Then 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 | |||
38 | After 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 | |||
40 | Navigate in `cmd` to this repo and run: | ||
41 | ```cmd | ||
42 | cmake -G "MinGW Makefiles" CMakeLists.txt | ||
43 | ``` | ||
44 | |||
45 | Then you can build any of the [`/testing`](/testing) and [`/other`](/other) by running: | ||
46 | ```cmd | ||
47 | mingw32-make name_of_c_file | ||
48 | ``` | ||
49 | For example, to build [`Messenger_test.c`](/others/Messenger_test.c) you would run: | ||
50 | ```cmd | ||
51 | mingw32-make Messenger_test | ||
52 | ``` \ No newline at end of file | ||
diff --git a/docs/TODO.txt b/docs/TODO.txt index 92817a18..5d65e12f 100644 --- a/docs/TODO.txt +++ b/docs/TODO.txt | |||
@@ -27,7 +27,9 @@ Things to do now: | |||
27 | 27 | ||
28 | Things to do later: | 28 | Things to do later: |
29 | 29 | ||
30 | -Figure out the whole sound and video transmission. | 30 | -Figure out the whole sound and video transmission. (encrypted and fast) |
31 | |||
32 | -File transfer (encrypted and fast) | ||
31 | 33 | ||
32 | Less important. | 34 | Less important. |
33 | 35 | ||