diff --git a/readme.md b/readme.md index 88f8a516..b7edf6bd 100644 --- a/readme.md +++ b/readme.md @@ -27,16 +27,16 @@ Introduction [![Gitter](https://badges.gitter.im/JoinChat.svg)](https://gitter.im/ChaiScript/ChaiScript?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) -ChaiScript is one of the only embedded scripting language designed from the -ground up to directly target C++ and take advantage of modern C++ development +ChaiScript is one of the only embedded scripting language designed from the +ground up to directly target C++ and take advantage of modern C++ development techniques, working with the developer how they would expect it to work. Being a -native C++ application, it has some advantages over existing embedded scripting +native C++ application, it has some advantages over existing embedded scripting languages: -1. It uses a header-only approach, which makes it easy to integrate with +1. It uses a header-only approach, which makes it easy to integrate with existing projects. 2. It maintains type safety between your C++ application and the user scripts. -3. It supports a variety of C++ techniques including callbacks, overloaded +3. It supports a variety of C++ techniques including callbacks, overloaded functions, class methods, and stl containers. @@ -66,17 +66,17 @@ Usage * Add the ChaiScript include directory to your project's header search path * Add `#include ` to your source file -* Instantiate the ChaiScript engine in your application. For example, create a +* Instantiate the ChaiScript engine in your application. For example, create a new engine with the name `chai` like so: `chaiscript::ChaiScript chai` -* The default behavior is to load the ChaiScript standard library from a +* The default behavior is to load the ChaiScript standard library from a loadable module. A second option is to compile the library into your code, see below for an example. -Once instantiated, the engine is ready to start running ChaiScript source. You -have two main options for processing ChaiScript source: a line at a time using +Once instantiated, the engine is ready to start running ChaiScript source. You +have two main options for processing ChaiScript source: a line at a time using `chai.eval(string)` and a file at a time using `chai.eval_file(fname)` -To make functions in your C++ code visible to scripts, they must be registered +To make functions in your C++ code visible to scripts, they must be registered with the scripting engine. To do so, call add: chai.add(chaiscript::fun(&my_function), "my_function_name"); @@ -86,15 +86,15 @@ Once registered the function will be visible to scripts as "my_function_name" Examples ======== -ChaiScript is similar to ECMAScript (aka JavaScript(tm)), but with some -modifications to make it easier to use. For usage examples see the "samples" -directory, and for more in-depth look at the language, the unit tests in the +ChaiScript is similar to ECMAScript (aka JavaScript(tm)), but with some +modifications to make it easier to use. For usage examples see the "samples" +directory, and for more in-depth look at the language, the unit tests in the "unittests" directory cover the most ground. -For examples of how to register parts of your C++ application, see -"example.cpp" in the "samples" directory. Example.cpp is verbose and shows every -possible way of working with the library. For further documentation generate -the doxygen documentation in the build folder or see the website +For examples of how to register parts of your C++ application, see +"example.cpp" in the "samples" directory. Example.cpp is verbose and shows every +possible way of working with the library. For further documentation generate +the doxygen documentation in the build folder or see the website http://www.chaiscript.com.