Document and create initial examples bundled with nupic.core

[subutai]

nupic.core contains the core C++ library for NuPIC. We should have some example applications as well that demonstrate how to use it. Some suggestions:

• a simple "hello NuPIC" application demonstrating the simplest case. This might not do anything useful, but developers can use this as a base for building their own applications. (Create pure C++ example code for Network API #142)
• a unix style command line interface program. This could take network configuration file as input and then accept data through stdin and write results to stdout. The program could be chained with pipes just like any other unix executable. Could be a very easy app for new users. @sjmackenzie's idea. (Create command line example for Network API #175)
• maybe a more complex demo app that solves a real problem and demonstrates a more real world use case of the API and algorithms. (Create complete C++ demo for Network API for a real problem #176)

Ultimately we might want to split these into their own repo.

[sjmackenzie]

On one hand I think the CLI will be so small one could just sneak it in with the static/dynamic library. (we have to come up with an excellent name for the executable!)

On the other hand, from core's perspective the CLI would become a favourite and that isn't too good for the entire binding eco-system. So really the CLI should be just another citizen in core's kingdom. Demos, man pages and examples should be shipped with the CLI program. Indeed every language binding should have its own set of examples,documentation etc.

Core should just have API documentation available in the repo. Otherwise it should only deploy include files and the binary file.

[rhyolight]

@subutai Is this a duplicate of #142?

[subutai]

I guess #142 is one example. The CLI idea would be very cool once we have all the algorithms in nupic.core. I guess we should create separate issues for these!

[rhyolight]

Assigning to myself to split into separate issues next sprint.

[rhyolight]

Closing this. Replaced with:

• Create pure C++ example code for Network API #142
• Create complete C++ demo for Network API for a real problem #176