diff --git a/README.md b/README.md new file mode 100644 index 0000000..6906849 --- /dev/null +++ b/README.md @@ -0,0 +1,20 @@ +# Variant + +The Variant is a General Purpose variable which can hold a value of (almost) any type. + +## Building +* Clone the repository + - `git clone http://gitlab.osdev.nl/open_source/datatypes.git` + +* Change to the git-repository and run the submodules script. + - `cd datatypes` + - `scripts/setup_submodules -i` + +* Create the build directory and build the library and tests + * `mkdir build` + * `cd build` + * `cmake ../` + * `gmake` + +* Start the test from the build directory + * `tests/datatypestest`