Skip to content

Commit 4fe1bfb

Browse files
committed
Update usage/example and readme.
1 parent 54ea21c commit 4fe1bfb

File tree

2 files changed

+10
-8
lines changed

2 files changed

+10
-8
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,10 @@ This is a GLua fork of [Lua_midiParser](https://github.com/FMS-Cat/Lua_midiParse
77

88
```lua
99
-- Will attempt to parse "garrysmod/data/abcdef.mid" file
10-
-- myMidi = midiParser( "abcdef.mid" )
10+
myMidi = midiParser( "abcdef.mid" )
1111

1212
-- Will attempt to parse "garrysmod/lua/test.mid" file
13-
-- myMidi = midiParser( "test.mid", "LUA" )
13+
testingMidi = midiParser( "test.mid", "LUA" )
1414
```
1515

1616
## Return sample

midi-parser.lua

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
1-
-- Usage:
2-
-- midi = midiParser( fileName[, path="DATA"] )
3-
4-
-- Example:
5-
-- myMidi = midiParser( "abcdef.mid" ) -- Will attempt to parse "garrysmod/data/abcdef.mid" file
6-
-- myMidi = midiParser( "test.mid", "LUA" ) -- Will attempt to parse "garrysmod/lua/test.mid" file
1+
--[[-----------------------------------------------------------------------------------------------
2+
-- USAGE --
3+
midi = midiParser( fileName[, path="DATA"] )
4+
5+
-- EXAMPLE --
6+
myMidi = midiParser( "abcdef.mid" ) -- Will attempt to parse "garrysmod/data/abcdef.mid" file
7+
myMidi = midiParser( "test.mid", "LUA" ) -- Will attempt to parse "garrysmod/lua/test.mid" file
8+
-------------------------------------------------------------------------------------------------]]
79

810
_G.midiParser = function( fileName, path )
911

0 commit comments

Comments
 (0)