diff --git a/README b/README index e69de29..b7f7c9a 100644 --- a/README +++ b/README @@ -0,0 +1,17 @@ +Lokrez +====== + +A smash.gg-aware local-results generator for Super Smash Brothers Ultimate. + + +Requirements +------------ + +=== Templates +The *rebootlyon* template needs the *Impact* font (available by default on +Windows, install +ttf-mscorefonts-installer+ on Ubuntu or Debian). + +=== Images +The SSBU characters images are not included (since this is both copyrighted +work and a lot of heavy bitmaps), you'll have to get them by your own means and +put them in the +res/ssbu+ directory.