From 37986c7be148890a4ca5515f56bddfc4fb7bfddb Mon Sep 17 00:00:00 2001 From: The Phantom Derpstorm Date: Mon, 21 Mar 2016 12:26:07 -0400 Subject: [PATCH 1/3] Updated readme to make it apparent where to go to get stuff. --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index f860fda7..69bbb582 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,10 @@ Sol is a C++ library binding to Lua. It currently supports all Lua versions 5.1+ (LuaJIT 2.x included). Sol aims to be easy to use and easy to add to a project. The library is header-only for easy integration with projects. +## Documentation + +Find it [here](http://sol2.rtfd.org/). A run-through kind of tutorial is in the works: check back soon! The API documentation goes over most cases (particularly, the "api/usertype" and "api/proxy" and "api/function" sections) that should still get you off your feet and going, and there's an examples directory [here](https://github.com/ThePhD/sol2/tree/develop/examples) as well. + ## Sneak Peek ```cpp From 8734ba556e4ffa9b384a38d3dcd90e2ff3fe3b9c Mon Sep 17 00:00:00 2001 From: The Phantom Derpstorm Date: Mon, 21 Mar 2016 12:37:10 -0400 Subject: [PATCH 2/3] Update README.md --- README.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 69bbb582..d0d5454d 100644 --- a/README.md +++ b/README.md @@ -46,7 +46,7 @@ More examples are given in the examples directory. ## Creating a single header -For maximum ease of use, a script called `single.py` is provided. You can run this script to create a single file version of the library so you can only include that part of it. Check `single.py --help` for more info. +Check the releases tab on github for a provided single header file for maximum ease of use. A script called `single.py` is provided in the repository if there's some bleeding edge change that hasn't been published on the releases page. You can run this script to create a single file version of the library so you can only include that part of it. Check `single.py --help` for more info. ## Features @@ -67,13 +67,12 @@ officially supported and CI-tested compilers are: - GCC 4.9.0+ - Clang 3.5+ -- Visual Studio 2015 Community (Visual C++ 14.0) and above (tested manually) +- Visual Studio 2015 Community (Visual C++ 14.0)+ ## Caveats Due to how this library is used compared to the C API, the Lua Stack is completely abstracted away. Not only that, but all -Lua errors are thrown as exceptions instead: if you don't want to deal with errors thrown by at_panic, you can set your own panic function -or use the `protected_function` API. This allows you to handle the errors gracefully without being forced to exit. +Lua errors are thrown as exceptions instead: if you don't want to deal with errors thrown by at_panic, you can set your own panic function or use the `protected_function` API. This allows you to handle the errors gracefully without being forced to exit. If you don't want to deal with exceptions, then define `SOL_NO_EXCEPTIONS`. If you also don't like RTTI, you can also turn on `SOL_NO_RTTI` as well. These flags are automatically defined if the code detects certain compiler-specific macros being turned on or off. It should be noted that the library itself depends on `lua.hpp` to be found by your compiler. It uses angle brackets, e.g. `#include `. From 38c2376bfbc66799f55956b39c6554a3b49bfe9f Mon Sep 17 00:00:00 2001 From: The Phantom Derpstorm Date: Mon, 21 Mar 2016 12:39:47 -0400 Subject: [PATCH 3/3] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d0d5454d..48c7fbce 100644 --- a/README.md +++ b/README.md @@ -72,7 +72,7 @@ officially supported and CI-tested compilers are: ## Caveats Due to how this library is used compared to the C API, the Lua Stack is completely abstracted away. Not only that, but all -Lua errors are thrown as exceptions instead: if you don't want to deal with errors thrown by at_panic, you can set your own panic function or use the `protected_function` API. This allows you to handle the errors gracefully without being forced to exit. If you don't want to deal with exceptions, then define `SOL_NO_EXCEPTIONS`. If you also don't like RTTI, you can also turn on `SOL_NO_RTTI` as well. These flags are automatically defined if the code detects certain compiler-specific macros being turned on or off. +Lua errors are thrown as exceptions instead: if you don't want to deal with errors thrown by at_panic, you can set your own panic function or use the `protected_function` API. This allows you to handle the errors gracefully without being forced to exit. If you don't want to deal with exceptions, then define `SOL_NO_EXCEPTIONS`. If you also don't like RTTI, you can also define `SOL_NO_RTTI` as well. These macros are automatically defined if the code detects certain compiler-specific macros being turned on or off based on flags like `-fno-rtti` and `-fno-exceptions` It should be noted that the library itself depends on `lua.hpp` to be found by your compiler. It uses angle brackets, e.g. `#include `.