lertsenem
/
ssbu_lokrez
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add basic usage to README

master
Lertsenem 2020-07-09 15:40:16 +02:00
parent 4714071968
commit b0e76b562d
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.adoc
View File

@ -3,6 +3,18 @@ Lokrez
A smash.gg-aware local-results generator for Super Smash Brothers Ultimate. A smash.gg-aware local-results generator for Super Smash Brothers Ultimate.
Usage
-----
----
$> lokrez -t [your-smash.gg-auth-token] top8 [tournament-slug-or-id]
----
The resulting outputs will be in +tournament-slug.lkrz+ (text version) and
+tournament-slug.svg+ (image version).
Use the +--help+ option for further details.
Requirements Requirements
------------ ------------