Ready for 1.0

AuroraBertaOldham · May 25, 2020 · 3dcb500 · 3dcb500
1 parent 507d187
commit 3dcb500
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 4 deletions.
diff --git a/FNTTools/Program.cs b/FNTTools/Program.cs
@@ -25,7 +25,7 @@ private static int Main(string[] args)
 
         public int Run(string[] args)
         {
-            var root = new RootCommand("This program is a tool for working with Angel Code bitmap fonts (.fnt).")
+            var root = new RootCommand("This program is a tool for working with AngelCode bitmap fonts (.fnt).")
             {
                 CreateConvertCommand(),
                 CreateInspectCommand()
@@ -103,7 +103,7 @@ private Command CreateInspectCommand()
         {
             var sourceArgument = new Argument<string>("source", "The bitmap font to inspect.");
 
-            var allOption = new Option<bool>("--all", "Displays all blocks. Not recommended for large fonts.");
+            var allOption = new Option<bool>("--all", "Display all blocks.");
             var infoOption = new Option<bool>("--info", "Display the info block.");
             var commonOption = new Option<bool>("--common", "Display the common block.");
             var pagesOption = new Option<bool>("--pages", "Display the pages block.");
@@ -325,7 +325,7 @@ private void InspectPage(int id, string file, IConsole console)
         private int? GetKerningPairAmountWithErrorMessage(KerningPair kerningPair, BitmapFont bitmapFont, IConsole console)
         {
             if (bitmapFont.KerningPairs != null && bitmapFont.KerningPairs.TryGetValue(kerningPair, out var amount)) return amount;
-            console.Out.WriteLine($"Kerning Pair with the first \"{kerningPair.First}\" and second \"{kerningPair.Second}\" does not exist.");
+            console.Out.WriteLine($"Kerning Pair with the first \"{kerningPair.First}\" and the second \"{kerningPair.Second}\" does not exist.");
             console.Out.WriteLine();
             return null;
         }

diff --git a/README.md b/README.md
@@ -1,6 +1,12 @@
 # FNTTools
 ## Introduction
-FNTTools is a command line application for converting and analyzing Angel Code bitmap font files (.fnt). It is still a work in progress, but it should run on Windows, macOS, and Linux. If you any ideas for new functionality, please create an issue. I don't intend to add generating bitmap fonts, however.
+FNTTools is a command line application for converting and inspecting [AngelCode bitmap fonts (.fnt)](http://www.angelcode.com/products/bmfont/). It is available for Windows (x86 and ARM), macOS (x86-64), and Linux (x86-64 and ARM). If you have any ideas for new functionality, please create an issue. I don't intend to add generating bitmap fonts, however. Check out my library [SharpFNT](https://github.com/AuroraBertaOldham/SharpFNT) to read and write AngelCode bitmap fonts in your own C# projects.
+
+## Download
+FNTTools can be downloaded from the releases section. The executables are self-contained so downloading the .NET Core runtime is unnecessary. A side effect of this however is that the executables have a file size of about 30-40MB.
+
+## Changelog
+Available [here](CHANGELOG.md).
 
 ## License
 Licensed under [MIT](LICENSE).