Merge pull request #47 from DavidRagazzi/master

Independent Build Process

.gitignore

@@ -0,0 +1,26 @@
+.metadata
+.idea
+*.class
+*.am
+*.in
+*.manifest
+*.cache
+*~
+*.DS_Store
+*.swp
+
+html/
+
+Servers/
+
+# Build artifacts and .bashrc artifacts
+build/
+build/scripts/
+build/release/
+build/temp/
+
+src/test/testeverything/everything_addtests.hpp
+src/test/testeverything/everything_headers.hpp
+
+# /
+/.gdb_history

.travis.yml

@@ -4,6 +4,11 @@ compiler:
   - clang
   - gcc
 
+env:
+  matrix:
+    - CC=clang
+    - CC=gcc
+
 notifications:
   irc:
     channels:
@@ -15,8 +20,14 @@ before_install:
   - if [ "$CC" = "clang" ]; then export CXX=clang++; fi
 
 install:
-  - echo This is where the build should happen
+  - "mkdir -p $TRAVIS_BUILD_DIR/build/scripts"
+  - "cd $TRAVIS_BUILD_DIR/build/scripts"
+  - "cmake $TRAVIS_BUILD_DIR/src"
 
 script:
-  - echo This is where the tests should run
-
+  - "cd $TRAVIS_BUILD_DIR/build/scripts"
+  - "make -j3"
+  # legacy binary tests
+  - "$TRAVIS_BUILD_DIR/build/release/bin/htmtest"
+  # (not quite everything, really)
+  - "$TRAVIS_BUILD_DIR/build/release/bin/testeverything"

Doxyfile

@@ -51,7 +51,7 @@ PROJECT_BRIEF          = "Numenta Platform for Intelligent Computing"
 # and the maximum width should not exceed 200 pixels. Doxygen will copy the logo
 # to the output directory.
 
-PROJECT_LOGO           = docs/numenta-logo.png
+PROJECT_LOGO           = doc/numenta-logo.png
 
 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
 # into which the generated documentation will be written. If a relative path is
@@ -743,7 +743,7 @@ WARN_LOGFILE           =
 # spaces.
 # Note: If this tag is empty the current directory is searched.
 
-INPUT                  = docs \
+INPUT                  = doc \
                          engine/NuPIC.hpp \
                          engine/Network.hpp \
                          engine/Region.hpp \
@@ -1044,7 +1044,7 @@ HTML_FILE_EXTENSION    = .html
 # of the possible markers and block names see the documentation.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
-HTML_HEADER            = docs/header.html
+HTML_HEADER            = doc/header.html
 
 # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
 # generated HTML page. If the tag is left blank doxygen will generate a standard
@@ -1054,7 +1054,7 @@ HTML_HEADER            = docs/header.html
 # that doxygen normally uses.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
-HTML_FOOTER            = docs/footer.html
+HTML_FOOTER            = doc/footer.html
 
 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
 # sheet that is used by each HTML page. It can be used to fine-tune the look of
@@ -1066,7 +1066,7 @@ HTML_FOOTER            = docs/footer.html
 # obsolete.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
-HTML_STYLESHEET        = docs/qmi.css
+HTML_STYLESHEET        = doc/qmi.css
 
 # The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user-
 # defined cascading style sheet that is included after the standard style sheets

README.md

@@ -5,3 +5,48 @@
 **This README is incomplete!**
 
 This repository contains the C++ source code for the Numenta Platform for Intelligent Computing ([NuPIC](http://numenta.org/nupic.html)). It will eventually contain all algorithms for NuPIC, but is currently in a transition period. For details on building NuPIC within the python environment, please see http://github.com/numenta/nupic.
+
+## Build and test NuPIC Core:
+
+Important notes:
+ * $REPOSITORY is the current location of the repository that you downloaded from GitHub.
+
+### Using command line
+
+#### Configure and generate build files:
+
+    mkdir -p $REPOSITORY/build/scripts
+    cd $REPOSITORY/build/scripts
+    cmake $REPOSITORY/src
+
+#### Build:
+
+    cd $REPOSITORY/build/scripts
+    make -j3
+
+> **Note**: -j3 option specify '3' as the maximum number of parallel jobs/threads that Make will use during the build in order to gain speed. However, you can increase this number depending your CPU.
+
+#### Run the C++ tests:
+
+    cd $REPOSITORY/build/release/bin
+    htmtest
+    testeverything
+
+### Using graphical interface
+
+#### Generate the IDE solution:
+
+ * Open CMake executable.
+ * Specify the source folder ($REPOSITORY/src).
+ * Specify the build system folder ($REPOSITORY/build/scripts), i.e. where IDE solution will be created.
+ * Click 'Generate'.
+ * Choose the IDE that interest you (remember that IDE choice is limited to your OS, i.e. Visual Studio is available only on CMake for Windows).
+
+#### Build:
+
+ * Open 'nupic.core.*proj' solution file generated on $REPOSITORY/build/scripts.
+ * Run 'ALL_BUILD' project from your IDE.
+
+#### Run the C++ tests:
+
+ * Run 'HtmTest' and 'TestEverything' projects from your IDE (check 'output' panel to see the results).