docs: update prerequisites and enhance CLI usage instructions

Author: elkoDev

README.md

@@ -4,7 +4,7 @@
 
 ## 1 Prerequisites
 
-- Windows with TcXaeShell Version 15.0 or higher
+- Windows with TcXaeShell Version 15.0 (other versions have not been tested)
 
 ## 2 Installation
 

TcAutomation/README.md

@@ -15,3 +15,38 @@ msbuild /p:Configuration=Release TcAutomation.csproj
 - Open the [TcAutomationInstaller.iss](TcAutomationInstaller.iss) file within the Inno Setup.
 - Click the "Build/Compile" button (or press Ctrl+F9)."
 - The installer will be created in the [output](output) folder.
+
+## 4 CLI Usage
+
+**Note:** You typically don't call `TcAutomation.exe` directly. Instead, use the BCS Engineering DSL CLI tool:
+
+```bash
+bcs-engineering-cli beckhoff deploy <file>
+```
+
+The `deploy` command internally invokes `TcAutomation.exe` with the appropriate parameters. However, if you need to call it manually, the following options are available:
+
+### Command Line Options
+
+| Option            | Required | Default                                                             | Description                                        |
+| ----------------- | -------- | ------------------------------------------------------------------- | -------------------------------------------------- |
+| `--workspace`     | Yes      | -                                                                   | Path to your project root (where generated/ lives) |
+| `--solution-name` | No       | `MyGeneratedSolution`                                               | Name of the TwinCAT solution                       |
+| `--project-name`  | No       | `MyTwinCATProject`                                                  | Name of the Visual Studio project                  |
+| `--plc-name`      | No       | `MyPlcProject`                                                      | PLC project name                                   |
+| `--template-path` | No       | `C:\TwinCAT\3.1\Components\Base\PrjTemplate\TwinCAT Project.tsproj` | Path to your .tsproj template                      |
+| `--prog-id`       | No       | `TcXaeShell.DTE.15.0`                                               | ProgID to use when launching TwinCAT               |
+| `--ads-username`  | No       | `Administrator`                                                     | ADS username for remote connection                 |
+| `--ads-password`  | No       | `1`                                                                 | ADS password for remote connection                 |
+
+**Note:** If you're using a different TwinCAT version, you need to adjust the `--prog-id` parameter accordingly.
+
+### Example Usage
+
+```bash
+TcAutomation.exe --workspace "C:\Projects\MyProject"
+```
+
+```bash
+TcAutomation.exe --workspace "C:\Projects\MyProject" --solution-name "MySolution" --plc-name "MainPLC"
+```

language/README.md

@@ -49,20 +49,37 @@ or link the local version
 npm link
 ```
 
-## 3 Usage
+## 3 Usage (Beckhoff)
 
 ### 3.1 Generate Code
 
 ```bash
-bcs-engineering-cli beckhoff generate <path-to-bcsctrl-file>
+bcs-engineering-cli beckhoff generate <path-to-bcsctrl-file> [options]
 ```
 
+**Options:**
+
+- `-d, --destination <dir>` - Output directory for generated files
+- `-q, --quiet` - Suppress output (default: false)
+
 ### 3.2 Generate Code and Deploy
 
 ```bash
-bcs-engineering-cli beckhoff deploy <path-to-bcsctrl-file>
+bcs-engineering-cli beckhoff deploy <path-to-bcsctrl-file> [options]
 ```
 
+**Options:**
+
+- `--template-path <path>` - TwinCAT template path
+- `--solution-name <name>` - Solution name (default: `MyGeneratedSolution`)
+- `--project-name <name>` - Project name (default: `MyTwinCATProject`)
+- `--plc-name <name>` - PLC project name (default: `MyPlcProject`)
+- `--tc-exe <path>` - Path to TcAutomation executable (default: `TcAutomation.exe`, resolved from PATH)
+- `--ads-username <username>` - ADS username for remote connection (default: `Administrator`)
+- `--ads-password <password>` - ADS password for remote connection (default: `1`)
+- `-d, --destination <dir>` - Output directory for generated files
+- `-q, --quiet` - Suppress output (default: false)
+
 **NOTE:** The working directory will be set to the root of the provided file. This means that the .bcsctrl file can contain cross-references to other files in the same directory.
 
 ### 3.3 Supported Target Platforms
@@ -76,6 +93,7 @@ In addition to the standard libraries provided by Beckhoff, the following librar
 - `Tc3_DALI`: Please note that this library integration is not fully tested.
 
 ## 4 Future Work
+
 - Add support for more target platforms (e.g., Siemens, Codesys)
 - Add and test support for more bus systems (e.g., EtherCAT, Profinet)
 - Add a more sophisticated module system (e.g., support multiple files, packages, imports, etc.)
@@ -86,4 +104,4 @@ In addition to the standard libraries provided by Beckhoff, the following librar
 - Support UseStmt within FB logic
 - Look into debugging DSLs
 - Look into moving the framework to a web-based solution (both the DSL and the deployment tool)
-- Look into graphical modeling
+- Look into graphical modeling