epicknex/multi
1
0
Fork 0
Code Issues 5 Pull Requests 1 Actions Packages Projects Releases 13 Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Ryan Ward 2020-01-26 10:41:12 -05:00
parent af88b2a054
commit bcb7e97184
1 changed files with 16 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
README.md
View File

@ -1,15 +1,15 @@
# multi Version: 14.0.0 Bug fixes and cool new features added (See changes.md) # multi Version: 14.0.0 Bug fixes and cool new features added (See changes.md)
Found an issue? Please submit it and ill look into it! Found an issue? Please [submit it](https://github.com/rayaman/multi/issues) and ill look into it!
My multitasking library for lua. It is a pure lua binding, if you ignore the integrations and the love2d compat. If you find any bugs or have any issues, please let me know . **If you don't see a table of contents try using the ReadMe.html file. It is easier to navigate than readme**</br> My multitasking library for lua. It is a pure lua binding, if you ignore the integrations and the love2d compat. If you find any bugs or have any issues, please let me know.
INSTALLING INSTALLING
---------- ----------
Note: The latest version of Lua lanes is required if you want to make use of system threads on lua 5.1+. I will update the dependencies for Lua rocks since this library should work fine on lua 5.1+ You also need the lua-net library and the bin library. all installed automatically using luarocks. however you can do this manually if lanes and luasocket are installed. Links: Links to dependicies:
https://github.com/rayaman/bin [bin](https://github.com/rayaman/bin)
https://github.com/rayaman/multi [net](https://github.com/rayaman/net)
https://github.com/rayaman/net [lanes](https://github.com/LuaLanes/lanes)
To install copy the multi folder into your environment and you are good to go</br> To install copy the multi folder into your environment and you are good to go</br>
If you want to use the system threads, then you'll need to install lanes! If you want to use the system threads, then you'll need to install lanes!
@ -26,28 +26,27 @@ luarocks install lnet
Discord Discord
------- -------
For real-time assistance with my libraries! A place where you can ask questions and get help with any of my libraries. Also, you can request features and stuff there as well.</br> Have a question that you need asking? Or need realtime assistance? Feel free to join the discord!</br>
https://discord.gg/U8UspuA</br> https://discord.gg/U8UspuA</br>
Planned features/TODO Planned features/TODO
--------------------- ---------------------
- [ ] Finish Documentation - [ ] Finish Documentation
- [ ] Test for unknown bugs -- This is always going on - [ ] Network Parallelism rework
- [x] ~~Network Parallelism~~ This was fun, I have some more plans for this as well
Usage:</br> Usage:</br>
----- -----
```lua ```lua
-- Basic usage Alarms: Have been moved to the core of the library require("multi") would work as well local multi, thread = require("multi").init()
local multi = require("multi") -- gets the entire library mutli:newThread("Example",function()
alarm=multi:newAlarm(3) -- in seconds can go to .001 uses the built in os.clock() while true do
alarm:OnRing(function(a) thread.sleep(1)
print("3 Seconds have passed!") print("Hello!")
a:Reset(n) -- if n were nil it will reset back to 3, or it would reset to n seconds end
end) end)
multi:mainloop() -- the main loop of the program, multi:umanager() exists as well to allow integration in other loops Ex: love2d love.update function. More on this binding in the wiki! multi:mainloop()
``` ```
Known Bugs/Issues Known Bugs/Issues
----------------- -----------------
Currently no bugs that I know of :D Check the Issue tab for issues