mirror of
https://github.com/ThePhD/sol2.git
synced 2024-03-22 13:10:44 +08:00
[ci skip] Improve single-header file documentation
This commit is contained in:
parent
09ee4db1ed
commit
76b73bdfab
|
@ -3,7 +3,7 @@ getting started
|
|||
|
||||
Let's get you going with Sol! To start, you'll need to use a lua distribution of some sort. Sol doesn't provide that: it only wraps the API that comes with it, so you can pick whatever distribution you like for your application. There are lots, but the two popular ones are `vanilla Lua`_ and speedy `LuaJIT`_ . We recommend vanilla Lua if you're getting started, LuaJIT if you need speed and can handle some caveats: the interface for Sol doesn't change no matter what Lua version you're using.
|
||||
|
||||
After that, make sure you grab either the `single header file release`_, or just perform a clone of the `github repository here`_ and set your include paths up so that you can get at ``sol.hpp`` somehow. We recommend the single-header-file release, since it's easier to move around, manage and update if you commit it with some form of version control. If you use the github release, you *must* update submodules in order to make sure Optional is present in the repository: clone with:
|
||||
After that, make sure you grab either the `single header file release`_, or just perform a clone of the `github repository here`_ and set your include paths up so that you can get at ``sol.hpp`` somehow. Note that we also have the latest version of the single header file with all dependencies included kept in the `repository as well`_. We recommend the single-header-file release, since it's easier to move around, manage and update if you commit it with some form of version control. If you use the github clone method and do not point to the `single/sol/sol.hpp`_ on your include files, you *must* update submodules in order to make sure Optional is present in the repository. Clone with:
|
||||
|
||||
>>> git clone https://github.com/ThePhD/sol2.git
|
||||
>>> git submodule update --init
|
||||
|
@ -73,4 +73,8 @@ Next, let's start :doc:`reading/writing some variables<variables>` from Lua into
|
|||
|
||||
.. _single header file release: https://github.com/ThePhD/sol2/releases
|
||||
|
||||
.. _repository as well: https://github.com/ThePhD/sol2/blob/develop/single/sol/sol.hpp
|
||||
|
||||
.. _single/sol/sol.hpp: https://github.com/ThePhD/sol2/blob/develop/single/sol/sol.hpp
|
||||
|
||||
.. _github repository here: https://github.com/ThePhD/sol2
|
Loading…
Reference in New Issue
Block a user