Merge pull request #154 from p01arst0rm/update-build-info

updated build information

Author: alanw

README.md

@@ -7,7 +7,7 @@ Lucene++ is an up to date C++ port of the popular Java [Lucene](http://lucene.ap
 library, a high-performance, full-featured text search engine.
 
 
-Components
+Lucene++ Components
 ----------------
 
 - liblucene++ library
@@ -17,6 +17,8 @@ Components
 - indexfiles (demo)
 - searchfiles (demo)
 
+For information on building the Lucene++ suite, please read doc/BUILDING.md
+
 
 Useful Resources
 ----------------
@@ -26,52 +28,6 @@ documentation relevant to Lucene and lucene++. [Lucene in Action](https://www.am
 by Otis Gospodnetic and Erik Hatcher.
 
 
-Build Instructions
-------------------
-
-You'll need the [Boost](http://www.boost.org) libraries installed somewhere.
-
-On Debian systems, the following packages are required:
-- zlib1g-dev
-- libboost-date-time-dev
-- libboost-filesystem-dev
-- libboost-regex-dev
-- libboost-thread-dev
-- libboost-iostreams-dev
-
-To build the library the following commands should be issued::
-
-    $ mkdir build; cd build
-    $ cmake ..
-    $ make
-    $ make install
-
-
-Build Instructions for Windows systems
---------------------------------------
-
-Once installing the dependencies, open cmake-gui and configure the build.
-When building on windows, ensure that the `ENABLE_CYCLIC_CHECK` option
-is set to `true`.
-
-Next, open the visual studio project with the 'open project' button. the
-project is built using the `ALL_BUILD` solution in the projects column.
-If you would like to install the project, build the `INSTALL` solution 
-after the fact.
-
-**
-Note: if you wish to install the Lucene++ library to a protected area, you
-must re-open the visual studio project as an administrator
-**
-
-**
-Note: "BOOST_ROOT" environment variable must be defined to point to the 
-Boost library directory (eg. c:\\local\\Boost). cmake should automatically
-find the installed libraries if they are installed within that path; 
-e.g. C:\\local\\Boost\\lib64-msvc-14.2 
-**
-
-
 To run unit test suite
 ----------------------
 
@@ -92,8 +48,6 @@ recieve errors telling you that required libraries cannot be found.
 Command options can be discovered by supplying `--help`.
 
 
-
-
 To run the demos
 ----------------
 

doc/BUILDING.md

@@ -0,0 +1,56 @@
+Build Instructions
+==========
+
+You'll need the following dependencies installed on your system.
+
+- [ZLib](https://zlib.net/)
+- [Boost](http://www.boost.org) libraries::
+    - date-time
+    - filesystem
+    - regex
+    - thread
+    - iostreams 
+
+e.g. on Debian systems, the following packages are required:
+- zlib1g-dev
+- libboost-date-time-dev
+- libboost-filesystem-dev
+- libboost-regex-dev
+- libboost-thread-dev
+- libboost-iostreams-dev
+
+
+Build Instructions for linux systems
+--------------------------------------
+
+To build the library the following commands should be issued::
+
+    $ mkdir build; cd build
+    $ cmake ..
+    $ make
+    $ make install
+
+Build Instructions for Windows systems
+--------------------------------------
+
+Once you have installed the dependencies and added the installation 
+location to your `CMAKE_PREFIX_PATH`, open cmake-gui and configure the 
+build. When building on windows, ensure that the `ENABLE_CYCLIC_CHECK`
+option is set to `true`.
+
+Next, open the visual studio project with the 'open project' button. the
+project is built using the `ALL_BUILD` solution in the projects column.
+If you would like to install the project, build the `INSTALL` solution 
+after the fact.
+
+**
+Note: if you wish to install the Lucene++ library to a protected area, you
+must re-open the visual studio project as an administrator
+**
+
+**
+Note: "BOOST_ROOT" environment variable must be defined to point to the 
+Boost library directory (eg. c:\\local\\Boost). cmake should automatically
+find the installed libraries if they are installed within that path; 
+e.g. C:\\local\\Boost\\lib64-msvc-14.2 
+**