Update README

Author: tomc128

BooleanExpressionParser/.vscode/launch.json

@@ -8,15 +8,17 @@
             "preLaunchTask": "build",
             "program": "${workspaceFolder}/bin/Debug/net7.0/BooleanExpressionParser.dll",
             "args": [
-                // "table",
+                "-o",
+                "basic",
+                "table",
                 // "-t ✅",
                 // "-f ❌",
-                // "A.B+!A",
-                // "A+B+C",
-                // "D_0.D_1"
-                "convert",
-                "A.B",
-                "A+B",
+                "A.B+!A",
+                "A+B+C",
+                "D_0.D_1",
+                // "convert",
+                // "A.B",
+                // "A+B",
                 // "!(A+B+C)",
                 // "(((A.B&C) OR A) AND (NOT B + !C)) AND NOT D",
                 // "[D_0 . !S] + [D_1 . S];S,D_0,D_1",

BooleanExpressionParser/Program.cs

@@ -19,7 +19,7 @@ private static void Main(string[] args)
     {
         Console.OutputEncoding = Encoding.UTF8;
 
-        var rootCommand = new RootCommand();
+        var rootCommand = new RootCommand(description: "A boolean expression parser and evaluator.");
 
         // Shared arguments
         var expressionsArgument = new Argument<string[]>("expression(s)", description: "The boolean expression(s) to evaluate.");

README.md

@@ -8,8 +8,9 @@ A simple boolean expression parser written in C#. It parses boolean expressions
 - [Running](#running)
 - [Building](#building)
 - [Display](#display)
-- [Usage](#usage)
-  - [Truth table generation](#truth-table-generation)
+- [Base Command](#base-command)
+- [Truth table generation](#truth-table-generation)
+- [Notation conversion](#notation-conversion)
 - [Expressions](#expressions)
 - [Variables](#variables)
 - [How it works](#how-it-works)
@@ -39,22 +40,40 @@ The application displays an intuitive, coloured truth table output for each bool
 ![Sample screenshot](./docs/sample-screenshot.png)
 
 
-## Usage
+## Base Command
+`./BooleanExpressionParser [command] [options]`
 
-### Truth table generation
-`./BooleanExpressionParser table <expression(s)>`
-#### Arguments: <!-- omit in toc -->
-  - <expression(s)> The boolean expression(s) to evaluate
-#### Options: <!-- omit in toc -->
-  - -t, --true <true> Character to use for true values in the truth table. [default: 1]
-  - -f, --false <false> Character to use for false values in the truth table. [default: 0]
-  - -c, --colour-mode, --color-mode <colour-mode> Colour mode to use for the truth table. [default: Foreground]  [possible values: [Ff]oreground, [Bb]ackground, [Nn]one]
-  - --true-colour, --true-color <true-colour> Colour to use for true values in the truth table. [default: green]  [possible values: 16 ANSI colours, hex string, rgb string]
-  - --false-colour, --false-color <false-colour> Colour to use for false values in the truth table. [default: red]  [possible values: 16 ANSI colours, hex string, rgb string]
+### Options: <!-- omit in toc -->
+  - `-o`, `--output`, `--output-type` `<Basic|Display>` The output type to use.
 
-More usage options to be implemented in the future.
 
-For help, run `./BooleanExpressionParser --help`. For help with a specific command, run `./BooleanExpressionParser <command> --help`.
+## Truth table generation
+Converts a boolean expression(s) to prefix notation. If none are provided, the user will be prompted to enter them.
+
+### Usage: <!-- omit in toc -->
+  `./BooleanExpressionParser table [<expression(s)>...] [options]`
+### Arguments: <!-- omit in toc -->
+  - `<expression(s)>` The boolean expression(s) to evaluate.
+### Options: <!-- omit in toc -->
+  - `-t`, `--true` `<true>` Character to use for true values in the truth table. [default: 1]
+  - `-f`, `--false` `<false>` Character to use for false values in the truth table. [default: 0]
+  - `-c`, `--colour-mode`, `--color-mode` `<Background|Foreground|None>` Colour mode to use for the truth table. [default: Foreground]  (possible values: [Ff]oreground, [Bb]ackground, [Nn]one)
+  - `--true-colour`, `--true-color` `<true-colour>` Colour to use for true values in the truth table. [default: green]  (possible values: 16 ANSI colours, hex string, rgb string)
+  - `--false-colour`, `--false-color` `<false-colour>` Colour to use for false values in the truth table. [default: red]  (possible values: 16 ANSI colours, hex string, rgb string)
+
+
+## Notation conversion
+Converts a boolean expression(s) to prefix notation. If none are provided, the user will be prompted to enter them.
+
+### Usage: <!-- omit in toc -->
+`./BooleanExpressionParser convert [<expression(s)>...] [options]`
+### Arguments: <!-- omit in toc -->
+  - `<expression(s)>` The boolean expression(s) to convert
+
+
+More commands to be implemented in the future.
+
+For help, run `./BooleanExpressionParser --help`. For help with a specific command, run `./BooleanExpressionParser [command] --help` or `./BooleanExpressionParser --help [command]`.
 
 
 
@@ -137,9 +156,9 @@ For example:
 - [x] Improve console output with colours
 - [x] Implement command line arguments
 - [ ] Add raw output options
-  - [ ] Output prefix notation
+  - [x] Output prefix notation
   - [ ] Output specific output for given variables
-  - [ ] Output machine-readable truth table
+  - [x] Output machine-readable truth table
 - [ ] Create UI for the application, either web-based or desktop-based