From cebeebdb7a85d46f1cb7b890d2c36128655f8147 Mon Sep 17 00:00:00 2001 From: Jason Turner Date: Sat, 13 Jun 2015 16:56:22 -0600 Subject: [PATCH] Minor cleanups and versioning info added --- cheatsheet.md | 37 ++++++++++++++++++++++++++----------- 1 file changed, 26 insertions(+), 11 deletions(-) diff --git a/cheatsheet.md b/cheatsheet.md index 5319e59..594b2f7 100644 --- a/cheatsheet.md +++ b/cheatsheet.md @@ -1,3 +1,13 @@ +# ChaiScript Versioning + +ChaiScript tries to follow the [Semantic Versioning](http://semver.org/) scheme. This basically means: + + * Major Version Number: API changes / breaking changes + * Minor Version Number: New Features + * Patch Version Number: Minor changes / enhancements + + + # Initializing ChaiScript ``` @@ -81,21 +91,21 @@ chai.add(chaiscript::const_var(somevar), "somevar"); // copied in and made const chai.add_global_const(chaiscript::const_var(somevar), "somevar"); // global const. Throws if value is non-const chai.add_global(chaiscript::var(somevar), "somevar"); // global non-const ``` -#Using STL +# Using STL ChaiScript recognize many types from STL, but you have to add specific instantiation yourself. ``` typedef std::vector> data_list; - data_list my_list{ make_pair(0, "Hello"), make_pair(1, "World") }; - chai.add(chaiscript::bootstrap::standard_library::vector_type("DataList")); - chai.add(chaiscript::bootstrap::standard_library::pair_type("DataElement")); - chai.add(chaiscript::var(&my_list), "data_list"); - chai.eval(R"_( - for(var i=0; i("DataList")); +chai.add(chaiscript::bootstrap::standard_library::pair_type("DataElement")); +chai.add(chaiscript::var(&my_list), "data_list"); +chai.eval(R"_( + for(var i=0; i