Merge pull request #152 from Ansa89/without-autotools

Update readme instructions

.gitignore

@@ -9,19 +9,10 @@
 *.app
 *.swp
 *.la
-m4/*
-!m4/pkg.m4
-configure
-configure_aux
-Makefile.in
-aclocal.m4
-config.h*
-config.log
-config.status
 stamp-h1
-autom4te.cache
 .deps
 .libs
 *.orig
 build/toxic
-Makefile
+build/*.o
+build/*.d

.travis.yml

@@ -7,7 +7,7 @@ before_script:
   # Installing yasm (needed for compiling vpx) and openal
   - sudo apt-get -yq install yasm libopenal-dev
   # Installing libsodium, needed for toxcore
-  - git clone git://github.com/jedisct1/libsodium.git > /dev/null
+  - git clone https://github.com/jedisct1/libsodium.git libsodium
   - cd libsodium
   - git checkout tags/0.4.2 > /dev/null
   - ./autogen.sh > /dev/null
@@ -16,7 +16,7 @@ before_script:
   - sudo make install > /dev/null
   - cd ..
   # Installing libopus, needed for audio encoding/decoding
-  - wget http://downloads.xiph.org/releases/opus/opus-1.0.3.tar.gz > /dev/null
+  - wget http://downloads.xiph.org/releases/opus/opus-1.0.3.tar.gz
   - tar xzf opus-1.0.3.tar.gz > /dev/null
   - cd opus-1.0.3
   - ./configure > /dev/null
@@ -24,7 +24,7 @@ before_script:
   - sudo make install > /dev/null
   - cd ..
   # Installing vpx
-  - git clone http://git.chromium.org/webm/libvpx.git > /dev/null
+  - git clone http://git.chromium.org/webm/libvpx.git libvpx
   - cd libvpx
   - ./configure --enable-shared > /dev/null
   - make -j2 || make || exit 1 > /dev/null

README.md

@@ -1,25 +1,35 @@
 # Toxic
+Toxic is an ncurses based instant messaging client for [Tox](https://tox.im) which formerly resided in the [Tox core repository](https://github.com/irungentoo/toxcore) and is now available as a standalone program. It looks like [this](http://i.imgur.com/hL7WhVl.png).
 
-Toxic is an ncurses based instant messaging client for [Tox](http://tox.im) which formerly resided in the [Tox core repository](https://github.com/irungentoo/ProjectTox-Core) and is now available as a standalone program. It looks like [this](http://i.imgur.com/hL7WhVl.png).
 ## Installation
-* Generate the configure script by running the ```autoreconf -i``` command.
 
-* Execute the configure script with ```./configure``` (you may need to pass it the location of your dependency libraries, i.e.):
+### Base dependencies
-```./configure --prefix=/where/to/install --with-libtoxcore-headers=/path/to/ProjectTox-Core/toxcore --with-libtoxcore-libs=/path/to/ProjectTox-Core/build/.libs --with-libsodium-headers=/path/to/libsodium/include/ --with-libsodium-libs=/path/to/sodiumtest/lib/ ```
+* libtoxcore
+* ncurses (for Debian based systems: libncurses5-dev libncursesw5-dev)
 
-* Audio calling support requires openal installed
+### Audio dependencies
-* Compile with --disable-av to build without audio call support
+* libtoxav
-* Compile and install the program with ```make && sudo make install```
+* openal
 
-#### Notes
+### Compiling
-If your default prefix is /usr/local and you get the error: "error while loading shared libraries: libtoxcore.so.0: cannot open shared object file: No such file or directory", then you can try running ```sudo ldconfig```. If that doesn't fix it, run:
+* `cd build/`
+* `make`
+* `sudo make install DESTDIR="/path/you/like"`
+* You can add specific flags to makefile with `USER_CFLAGS=""` and/or `USER_LDFLAGS=""`
+* You can pass your own flags to makefile with `CFLAGS=""` and/or `LDFLAGS=""` (this will supersede the defaults one)
+* Audio calling support is automatically enabled if all dependencies are found
+
+### Troubleshooting
+If your default prefix is "/usr/local" and you get the error:
+```
+error while loading shared libraries: libtoxcore.so.0: cannot open shared object file: No such file or directory
+```
+you can try fix it running `sudo ldconfig`.
+If that doesn't fix it, run:
 ```
 echo '/usr/local/lib/' | sudo tee -a /etc/ld.so.conf.d/locallib.conf
 sudo ldconfig
 ```
-If you dont already have them, you may need to install the ncurses libraries. For Debian based systems:
+
-```
-sudo apt-get install libncurses5-dev libncursesw5-dev
-```
 ## Settings
-After running Toxic for the first time an empty file called toxic.conf should reside in your home configuration directory (~/.config/tox for Linux users). For an example on how to use this config file to save settings such as auto-logging and time format see: toxic/misc/toxic.conf
+After running Toxic for the first time an empty file called toxic.conf should reside in your home configuration directory ("~/.config/tox" for Linux users). For an example on how to use this config file to save settings such as auto-logging and time format see: [misc/toxic.conf](misc/toxic.conf).