diff --git a/README.md b/README.md index 7e33d27..132f345 100644 --- a/README.md +++ b/README.md @@ -4,15 +4,17 @@ ## What is it? -ClipCMD is a windows app that allows you to create macros and run them by copying them to the clipboard. -You write a macro anywhere, copy it to your clipboard and it will be automatically replaced by the specified macro text. +ClipCMD is a Windows app that allows you to create macros and run them by copying them to the clipboard.\ +You write a macro anywhere, copy it to your clipboard, and it will be automatically replaced by the output of the specified macro script.\ +ClipCMD uses [PowerShell](https://learn.microsoft.com/en-us/powershell/scripting) as scripting language. ### Example > Prefix: `_`\ > Suffix: `_`\ > Macro name: `email`\ -> Macro text: `myCoolEmail@mail.com` +> Macro script: `Write-Output myCoolEmail@mail.com`\ +> Macro script (alternative): `"myCoolEmail@mail.com"` > Input: `_email_`\ > Output: `myCoolEmail@mail.com` @@ -20,13 +22,31 @@ You write a macro anywhere, copy it to your clipboard and it will be automatical ## Usage 1. Download one of the [releases](https://github.com/Stone-Red-Code/ClipCMD/releases) -1. Start `ClipCMD.exe` +1. Start `setup.exe` 1. (Optional) Set the prefix and suffix for your commands -1. Specify some commands in the built in text field - - Format: `[macroName]>[macroText]` - - Each line is a new macro -1. There are some built in macros like `time` and `date` which will output the current local time and date -1. Write `[suffix][macroName][preffix]` somewhere, and then select it and press ``CTRL+C`` +1. Specify some commands in the built-in text field + - Format: + ``` + [] + + + + ... + [] + + + + ... + ``` + - Strings between square brackets define macros. + - You can define macro aliases by separating them by a comma `[quit, exit, q]` + - Lines between a macro definition and the next macro (or the end of the file) is PowerShell code. + - Everything you write to the output stream replaces the input macro. + - You can pass parameters to the scripts by separating the parameters by space after the macro: `_combine hi nope_` + - You can access the parameters by accessing the `$args` array. +1. There is one prebuilt macro named `list`. This lists all of your macros. +1. Write `[suffix][macroName][preffix]` somewhere, and then select it and press `CTRL+C` ## Preview -Screenshot 2022-05-03 221232 + +image