library-mirrors/Piefiller
1
0
Fork 0
mirror of https://github.com/Polynominal/Piefiller.git synced 2024-11-12 11:14:21 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
devfirefly 2015-11-09 16:54:44 +00:00
parent 827f9349ab
commit aed4228649
1 changed files with 49 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -48,11 +48,25 @@ c = hides/shows hidden processes
p = saves to file called "Profile" and opens directory for you p = saves to file called "Profile" and opens directory for you
## To redefine these: ## To redefine these:
Modes available:
```lua
reset
increase_depth
decrease_depth
increase_step_size
decrease_step_size
shorten_names
show_hidden
save_to_file
```
To redefine only one of the keys: To redefine only one of the keys:
```lua ```lua
piefiller:setKey(mode,key) piefiller:setKey(mode,key)
``` ```
example: example:
```lua ```lua
piefiller:setKey("increase_depth","up") piefiller:setKey("increase_depth","up")
``` ```
@ -68,8 +82,9 @@ To redefine all of the keys:
# For your own interpretation # For your own interpretation
If you wish to interpret the data on your own use piefiller:unpack(). If you wish to interpret the data on your own use piefiller:unpack().
Output is a table as such: Output is a table as such:
```lua ```lua
local data = { data = {
items = { items = {
{ {
name, name,
@ -88,6 +103,7 @@ To redefine all of the keys:
}, },
} }
``` ```
# Additional notes # Additional notes
The best depth to search for is 2 and 3. The best depth to search for is 2 and 3.