Commit 2e3f544a authored by sirjorj's avatar sirjorj Committed by GitHub

update and clean up the README

parent f40b54e9
......@@ -33,16 +33,16 @@ Binaries are available http://sirjorj.com/jorj/xhud.html[here].
Download the latest build and extract it in your home directory. The build files (after v0.1) contain the following:
|===
|`xhud/` |A folder containing everything
|`xhud/xhud` |The program itself
|`xhud/fonts/` |A folder for the required fonts
|`xhud/fonts/README` |A text file explaining what other fonts are required
|`xhud/fonts/xwing-miniatures.ttf` |The font containing all the game sybols
|`xhud/fonts/xwing-miniatures-ships.ttf` |The font containing all the ship icons
|`xhud/` |A folder containing everything
|`xhud/xhud` |The program itself
|`LICENSE` |Licenses for all the parts that make this work
|`xhud/fonts/` |A folder for the required fonts
|`xhud/fonts/Squarish Sans CT Regular SC.ttf` |The text in the generated images
|`xhud/fonts/xwing-miniatures.ttf` |The game sybols
|`xhud/fonts/xwing-miniatures-ships.ttf` |The ship icons
|`xhud/fonts/xwstats.ttf` |The stat numbers in the generated images
|===
Read the README file. It will direct you on how to get the other fonts. Put them in the fonts directory with the two xwing-miniatures-* fonts. You should then be ready to go.
== Usage
Open up a terminal and switch to the xhud directory (cd xhud). You can now use xhud to do things.
......@@ -66,7 +66,7 @@ Notes:
* When specifying a ship/pilot/upgrade, use the xws format of it (all lowercase, no spaces or special characters)
* When viewing ships/pilots/upgrades, shaded items are unreleased
* To print info on a Ship/Pilot/Upgrade, you can copy the necessary input info from the list - they are ordered that way for a reason
* To print info on a ship/pilot/upgrade, you can copy the necessary input info from the list - they are ordered that way for a reason
== Running a Game
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment