improve documentation

README.md

@@ -7,4 +7,4 @@ libscipaper also allows you to get full text as well as pdf files for scientific
 
 For questions or comments, as well as help with the usage of the plugin API contact devnull@uvos.xyz
 
-Full API documentation is avialable at [here](http://uvos.xyz/kiss/libscipaperdoc)
+Full documentation is avialable at [here](http://uvos.xyz/kiss/libscipaperdoc)

doc/build.md

+\page BUILD build
+
+# Build instructions
+
+These build instructions assume that UNIX is being used as the host os, however building on MacOS or Microsoft Windows is possible given only minor alterations to the procedure below.
+
+## Requirments
+
+* [PkgConfig](https://www.freedesktop.org/wiki/Software/pkg-config/)
+	* Is required for the build system to find all the other dependancies.
+* [GLib](https://docs.gtk.org/glib/)  version 2.41 or better
+* [GModule](https://docs.gtk.org/gmodule/)
+* [CURL](https://curl.se/)
+* [git](https://git-scm.com/) is required to get the source.
+* a C compiler like [GCC](https://gcc.gnu.org/) is required.
+* optinonally:
+	* [libxml2](https://en.wikipedia.org/wiki/Libxml2) is required for the scihub backend
+	* [Doxygen](https://www.doxygen.nl/index.html) is required to generate the documentation
+
+## Compileing and Installing
+
+First we need to get the source, this can be perfomed by cloning https://github.com/IMbackK/libscipaper or https://git-ce.rwth-aachen.de/carl_philipp.klemm/libscipaper/ using git. Note that these two versions might not allways be totaly in sync.
+
+```
+$ git clone https://github.com/IMbackK/libscipaper
+```
+
+Then we must build and install the libary, to do this we must in the libscipaper do the following
+
+```
+$ mkdir build; cd build
+$ cmake ..
+$ make
+$ sudo make install
+```
+
+You may want to change the default install prefix from /usr/local to something else, for this add `-DCMAKE_INSTALL_PREFIX=` with the path you desire to the cmake command.
+
+## Linking
+
+With scipaper installed the header can be included with #include `<scipaper/scipaper.h>` and link with `-lscipaper`

doc/libscipaper.doxygen.in

@@ -864,7 +864,7 @@ WARN_LOGFILE           =
 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
 # Note: If this tag is empty the current directory is searched.
 
-INPUT                  = @CMAKE_CURRENT_SOURCE_DIR@/src/scipaper @CMAKE_CURRENT_SOURCE_DIR@/src/modapi @CMAKE_CURRENT_SOURCE_DIR@/doc/mainpage.txt
+INPUT                  = @CMAKE_CURRENT_SOURCE_DIR@/src/scipaper @CMAKE_CURRENT_SOURCE_DIR@/src/modapi @CMAKE_CURRENT_SOURCE_DIR@/doc/mainpage.txt @CMAKE_CURRENT_SOURCE_DIR@/doc/build.md
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses

doc/mainpage.txt

@@ -8,12 +8,18 @@ libscipaper is a modular library with each database backend provided by a plugin
 currently libscipaper has two finished backend plugins:
 - A core.ac.uk plugin
 - A crossref plugin
+- A scihub plugin
 
 For questions or comments, as well as help with the usage of the plugin API contact carl@uvos.xyz
 
+
+
 This manual is divided in the following sections depending on if you want to use libscipaper in your application or write a plugin for it:
 - \subpage userAPI
 - \subpage pluginAPI
+
+For build instructions see \ref BUILD.
+
 */
 
 //-----------------------------------------------------------