added documentation to read me.

This commit is contained in:
devfirefly
2015-11-09 16:45:48 +00:00
committed by Ilikepotatoes Theyarelikerlygood
parent fa55cd6764
commit 827f9349ab
2 changed files with 45 additions and 1 deletions

View File

@@ -47,6 +47,47 @@ s = shortens the names displayed
c = hides/shows hidden processes
p = saves to file called "Profile" and opens directory for you
## To redefine these:
To redefine only one of the keys:
```lua
piefiller:setKey(mode,key)
```
example:
```lua
piefiller:setKey("increase_depth","up")
```
To redefine all of the keys:
```lua
table = {
"increase_depth" = "up"
}
piefiller:setKey(table)
```
# For your own interpretation
If you wish to interpret the data on your own use piefiller:unpack().
Output is a table as such:
```lua
local data = {
items = {
{
name,
line_defined,
current_line,
source,
time_taken,
percentage,
caller,
}
},
about = {
depth,
step,
totalTime,
},
}
```
# Additional notes
The best depth to search for is 2 and 3.