GitHub/Basalt
1
0
Fork 0
Code Issues 28 Pull Requests 3 Actions Packages Projects Releases 9 Wiki Activity

Merge pull request #24 from EmmaKnijn/master

Browse Source 
Issues in the documentation that might've caused confusion
This commit is contained in:
Robert Jelic
2022-08-08 17:27:52 +02:00
committed by GitHub
parent cf387cab5a 039782ec0e
commit ad6bf96124
1 changed files with 3 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
docs/home/Quick-Start.md
View File

@@ -2,7 +2,7 @@
To load the framework into your project, make use of the following code on top of your code. To load the framework into your project, make use of the following code on top of your code.
```lua ```lua
local basalt = require("Basalt") local basalt = require("basalt")
``` ```
It does not matter if you have installed the single file version or the full folder project. <br> It does not matter if you have installed the single file version or the full folder project. <br>
@@ -43,11 +43,10 @@ The true keyword in the end is optional and would simply start BPM immediately.
Here is a fully functioning example of Basalt code Here is a fully functioning example of Basalt code
```lua ```lua
local basalt = require("Basalt") --> Load the Basalt framework local basalt = require("basalt") --> Load the Basalt framework
--> Create the first frame. Please note that Basalt needs at least one active "non-parent" frame to properly supply events --> Create the first frame. Please note that Basalt needs at least one active "non-parent" frame to properly supply events
--> When Basalt#createFrame makes use of unique identifiers (commonly referred to as UIDs), meaning that the supplied value must be UNIQUE --> When Basalt#createFrame makes use of unique identifiers (commonly referred to as UIDs), meaning that the supplied value must be UNIQUE
--> If the supplied UID is ambiguous, Basalt#createFrame returns a nil value
local mainFrame = basalt.createFrame("mainFrame") local mainFrame = basalt.createFrame("mainFrame")
--> Show the frame to the user --> Show the frame to the user
@@ -76,7 +75,7 @@ basalt.autoUpdate() --> Basalt#autoUpdate starts the event listener to detect us
``` ```
If you're like us and strive for succinct and beautiful code, here is a cleaner implementation of the code above: If you're like us and strive for succinct and beautiful code, here is a cleaner implementation of the code above:
```lua ```lua
local basalt = require("Basalt") local basalt = require("basalt")
local mainFrame = basalt.createFrame("mainFrame"):show() local mainFrame = basalt.createFrame("mainFrame"):show()
local button = mainFrame --> Basalt returns an instance of the object on most methods, to make use of "call-chaining" local button = mainFrame --> Basalt returns an instance of the object on most methods, to make use of "call-chaining"