Better readme, better examples, all better - cosmetics

Author: styczynski

README.md

@@ -1,2 +1,59 @@
 # poly-var-cpp
 Just-for-fun implementation of polymorphic variables in C/C++
+
+## Usage
+
+Clone the repository, go to the directory where it's placed
+and do `make` to get information about functionality of makefile.
+
+If you want to compile all examples do `make all`
+And then run any of the examples by running  `make run-example-aritm`, `make run-example-tree` etc.
+
+The basic usage looks like this:
+
+```c++
+#include <var>
+using namespace variable;
+
+int main() {
+  var x = 0;
+  x += "2.5";
+  cout<<x<<"\n";
+
+  return 0;
+}
+```
+
+Or if you want to use printf/scanf style:
+
+```c++
+#include <var>
+using namespace variable;
+
+int main() {
+  var x = 0;
+  x += "2.5";
+  printf("%d", (int)x);
+
+  return 0;
+}
+```
+
+You can read the standard input too (floats for example):
+
+```c++
+  var x;
+  cin >> x.castToFloat();
+```
+
+Or:
+```c++
+  var x;
+  scanf("%f", (float*)x);
+```
+
+
+## More examples
+
+Checkout examples/src for details about functionality of the module.
+Also you can see ./include/var.h to get more details.

examples/src/aritm.cpp

@@ -1,6 +1,6 @@
-#include <var.h>
-#include <var_math.h>
-#include <var_test.h>
+#include <var>
+#include <var_math>
+#include <var_test>
 
 using namespace variable;
 

examples/src/custom_struct.cpp

@@ -1,6 +1,6 @@
-#include <var.h>
-#include <var_math.h>
-#include <var_test.h>
+#include <var>
+#include <var_math>
+#include <var_test>
 
 using namespace variable;
 

examples/src/functions.cpp

@@ -1,6 +1,6 @@
-#include <var.h>
-#include <var_math.h>
-#include <var_test.h>
+#include <var>
+#include <var_math>
+#include <var_test>
 
 using namespace variable;
 

examples/src/generic_sorting.cpp

@@ -1,6 +1,6 @@
-#include <var.h>
-#include <var_math.h>
-#include <var_test.h>
+#include <var>
+#include <var_math>
+#include <var_test>
 
 using namespace variable;
 

examples/src/hashmap.cpp

@@ -1,6 +1,6 @@
-#include <var.h>
-#include <var_math.h>
-#include <var_test.h>
+#include <var>
+#include <var_math>
+#include <var_test>
 
 using namespace variable;
 

examples/src/performance1.cpp

@@ -1,6 +1,6 @@
-#include <var.h>
-#include <var_math.h>
-#include <var_test.h>
+#include <var>
+#include <var_math>
+#include <var_test>
 
 using namespace variable;
 

examples/src/sorting.cpp

@@ -1,6 +1,6 @@
-#include <var.h>
-#include <var_math.h>
-#include <var_test.h>
+#include <var>
+#include <var_math>
+#include <var_test>
 
 using namespace variable;
 

examples/src/tree.cpp

@@ -1,6 +1,6 @@
-#include <var.h>
-#include <var_math.h>
-#include <var_test.h>
+#include <var>
+#include <var_math>
+#include <var_test>
 
 using namespace variable;
 

include/var

@@ -0,0 +1,11 @@
+#define USE_DEFAULT_STRING_BEHAVIOUR
+#define NAMESPACE_VAR_BEGIN__ namespace variable {
+#define NAMESPACE_VAR_END__ };
+
+#define var_funct_decl(CODE) ((std::function<var(var)>)([&](var args)->var CODE))
+
+#include "var_custom_objects.h"
+#include "var.h"
+#include "var_basic_utilities.cpp"
+#include "var.cpp"
+#include "var_operator_toolkit.cpp"