diff --git a/docs/source/benchmarks.rst b/docs/source/benchmarks.rst index c011e0a3..f85277b6 100644 --- a/docs/source/benchmarks.rst +++ b/docs/source/benchmarks.rst @@ -25,6 +25,10 @@ Bars go up to the average execution time. Lower is better. Reported times are fo :target: https://raw.githubusercontent.com/ThePhD/lua-bench/master/lua%20-%20results/lua%20bench%20graph%20-%20member%20variable.png :alt: bind a variable to an object and call it in Lua code +.. image:: https://raw.githubusercontent.com/ThePhD/lua-bench/master/lua%20-%20results/lua%20bench%20graph%20-%20member%20variable.png + :target: https://raw.githubusercontent.com/ThePhD/lua-bench/master/lua%20-%20results/lua%20bench%20graph%20-%20many%20member%20variables.png + :alt: bind MANY variables to an object and call it in Lua code + .. image:: https://raw.githubusercontent.com/ThePhD/lua-bench/master/lua%20-%20results/lua%20bench%20graph%20-%20c%20function%20through%20lua.png :target: https://raw.githubusercontent.com/ThePhD/lua-bench/master/lua%20-%20results/lua%20bench%20graph%20-%20c%20function%20through%20lua.png :alt: retrieve a C function bound in Lua and call it from C++ diff --git a/docs/source/eevee_code_after.jpg b/docs/source/eevee_code_after.jpg new file mode 100644 index 00000000..33594ce5 Binary files /dev/null and b/docs/source/eevee_code_after.jpg differ diff --git a/docs/source/eevee_code_before.jpg b/docs/source/eevee_code_before.jpg new file mode 100644 index 00000000..ea9650ff Binary files /dev/null and b/docs/source/eevee_code_before.jpg differ diff --git a/docs/source/mentions.rst b/docs/source/mentions.rst index 4b11d3b1..7b920150 100644 --- a/docs/source/mentions.rst +++ b/docs/source/mentions.rst @@ -5,10 +5,24 @@ so does anyone cool use this thing...? Okay, so the features don't convince you, the documentation doesn't convince you, you want to see what *other* people think about Sol? Well, aside from the well-wishes that come through in the issue tracker, here's a few things floating around about sol2 that I occasionally get pinged about: +`eevee`_ demonstrating the sheer code reduction by using sol2: + + +.. |before| image:: eevee_code_before.jpg + :target: https://twitter.com/eevee/status/762039984085798913 + :alt: Plain C API + :align: middle + +.. |after| image:: eevee_code_after.jpg + :target: https://twitter.com/eevee/status/762039984085798913 + :alt: Now with sol2! + :align: middle + ++----------+---------+ +| |before| | |after| | ++----------+---------+ + -* (Reddit) Posts on reddit about it! - - https://www.reddit.com/r/cpp/comments/4a8gy7/sol2_lua_c_binding_framework/ - - https://www.reddit.com/r/cpp/comments/4x82hd/plain_c_versus_lua_libraries_benchmarking_speed/ * (CppNow) sol2 was mentioned in a comparison to other scripting languages by ChaiScript developer, Jason Turner (@lefticus), at a conference! - https://github.com/lefticus/presentations/blob/master/HowAndWhyToAddScripting.md * (CppCast) Showed up in CppCast with Elias Daler! @@ -16,13 +30,21 @@ Okay, so the features don't convince you, the documentation doesn't convince you - http://cppcast.com/2016/07/elias-daler/ * (Eevee) A really nice and neat developer/artist/howaretheysotalented person is attempting to use it for zdoom! - https://eev.ee/dev/2016/08/07/weekly-roundup-three-big-things/ -* (Twitter) Retweets by ThePhD from others! - - https://twitter.com/thephantomderp/status/755214464950034432 +* (Twitter) Twitter has some people that link it: + - https://twitter.com/eevee/status/762039984085798913 - https://twitter.com/thephantomderp/status/762043162835709952 - - https://twitter.com/thephantomderp/status/755214464950034432 -* Somehow landed on a Torque3D thread... that's nothing something ThePhD was planning for...! + - https://twitter.com/EliasDaler/status/739082026679173120 + - https://twitter.com/racodslair/status/754031870640267264 +* (Reddit) Posts on reddit about it! + - https://www.reddit.com/r/cpp/comments/4a8gy7/sol2_lua_c_binding_framework/ + - https://www.reddit.com/r/cpp/comments/4x82hd/plain_c_versus_lua_libraries_benchmarking_speed/ +* Somehow landed on a Torque3D thread... - http://forums.torque3d.org/viewtopic.php?f=32&t=629&p=5246&sid=8e759990ab1ce38a48e896fc9fd62653#p5241 -And, of course, ThePhD uses it. Isn't that enough? -Are you using sol2 for something neat? Want it to be featured here or think it's unfair that ThePhD hasn't found it yet? Well, drop an issue in the repo or send an e-mail! \ No newline at end of file +`Tell me about your uses!`_ + +Are you using sol2 for something neat? Want it to be featured here or think it's unfair that ThePhD hasn't found it yet? Well, drop an issue in the repo or send an e-mail! + +.. _Tell me about your uses!: https://github.com/ThePhD/sol2/issues/189 +.. _eevee: https://twitter.com/eevee \ No newline at end of file diff --git a/docs/source/tutorial/all-the-things.rst b/docs/source/tutorial/all-the-things.rst index f2f5ec87..fa9e73ac 100644 --- a/docs/source/tutorial/all-the-things.rst +++ b/docs/source/tutorial/all-the-things.rst @@ -246,7 +246,7 @@ Equivalent Lua code: You can put anything you want in tables as values or keys, including strings, numbers, functions, other tables. -Note that this idea that things can be nested is important and will help later when you get into :ref:`namespacing`. +Note that this idea that things can be nested is important and will help later when you get into :ref:`namespacing`. functions @@ -544,6 +544,9 @@ C++ classes put into Lua See this :doc:`section here` and after perhaps see if :doc:`simple usertypes suit your needs<../api/simple_usertype>`. Also check out some `a basic example`_, `special functions`_ and `initializers`_, + +.. _namespacing: + namespacing -----------