From e8d542ec489b9b154322ba4449d70cf2e0566f65 Mon Sep 17 00:00:00 2001 From: Ryan Ward Date: Sun, 10 Jun 2018 22:09:02 -0400 Subject: [PATCH] Updated Getting Started (markdown) --- Getting-Started.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/Getting-Started.md b/Getting-Started.md index 32df694..33d9cde 100644 --- a/Getting-Started.md +++ b/Getting-Started.md @@ -4,10 +4,14 @@ Setting up the library is simple. To setup simply copy the folder multi into you ```lua package.path="?/init.lua;"..package.path -- Then require like normal -require("multi.all") -- loads the library and all of the separate objects -``` +require("multi") -- loads the library and all of the separate objects -I recently added the modules to the system in the way they are now. Before everything was thrown into one lua file called **multiManager.lua** however this makes debugging harder and I didn't like that the requiring name was "multiManager" and the namespace was multi. This is why I changed it to multi for ease of debugging and to keep things consistent. This does however mean that the multi library has to be Global so each module can modify and add to it. +--or if you want to use system threading then you can do this + +local GLOBAL, THREAD = require("multi.integration.lanesManager") -- when using lanes +GLOBAL, THREAD = require("multi.integration.loveManager") -- when within the love2d engine +require("multi.integration.luvitManager") -- when using luvit framework +``` This also means that require does not return a handle for the library, instead the global environment is modified. This however is not a problem though.