Standardize README

This commit is contained in:
Stone_Red
2024-12-03 21:53:23 +01:00
parent 64e702a0da
commit a1e40bb87a
+29 -40
View File
@@ -1,56 +1,45 @@
# ClipCMD
![ClipCMD](https://socialify.git.ci/Stone-Red-Code/ClipCMD/image?description=1&font=Inter&forks=1&issues=1&logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPHN2ZyB3aWR0aD0iMTAwIiBoZWlnaHQ9IjEwMCIgdmlld0JveD0iMCAwIDEwMCAxMDAiIGZpbGw9Im5vbmUiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyI%2BCjxyZWN0IHk9IjAuMTE2NDU1IiB3aWR0aD0iMTAwIiBoZWlnaHQ9Ijk5Ljg4MzciIHJ4PSI0OS45NDE4IiBmaWxsPSJibGFjayIvPgo8cGF0aCBkPSJNMTkuMjMyMiA2OC41NUMxNi45NTg5IDY4LjU1IDE0Ljg1MDYgNjguMjAxNyAxMi45MDcyIDY3LjUwNUMxMC45NjM5IDY2LjgwODMgOS4yNTg4OSA2NS43NDUgNy43OTIyMyA2NC4zMTVDNi4zMjU1NiA2Mi44NDgzIDUuMTg4ODkgNjEuMDMzMyA0LjM4MjIzIDU4Ljg3QzMuNTc1NTYgNTYuNjcgMy4xNzIyMyA1NC4wNjY3IDMuMTcyMjMgNTEuMDZDMy4xNzIyMyA0OC4zODMzIDMuNDgzODkgNDYuMDU1IDQuMTA3MjMgNDQuMDc1QzQuNzMwNTYgNDIuMDk1IDUuNTczODkgNDAuNDI2NyA2LjYzNzIzIDM5LjA3QzcuNzAwNTYgMzcuNjc2NyA4LjkxMDU2IDM2LjU3NjcgMTAuMjY3MiAzNS43N0MxMS42MjM5IDM0LjkyNjcgMTMuMDUzOSAzNC4zMjE3IDE0LjU1NzIgMzMuOTU1QzE2LjA5NzIgMzMuNTg4MyAxNy42MDA2IDMzLjQwNSAxOS4wNjcyIDMzLjQwNUMyMi4xMTA2IDMzLjQwNSAyNC42OTU2IDM0LjAxIDI2LjgyMjIgMzUuMjJDMjguOTQ4OSAzNi40MyAzMC41NDM5IDM4LjA2MTcgMzEuNjA3MiA0MC4xMTVMMjguMDg3MiA0Mi4zMTVMMjcuNTkyMiA0Mi41OUwyNy4zNzIyIDQyLjIwNUMyNy40ODIyIDQxLjkxMTcgMjcuNDYzOSA0MS42NTUgMjcuMzE3MiA0MS40MzVDMjcuMjA3MiA0MS4xNzgzIDI2Ljk4NzIgNDAuODExNyAyNi42NTcyIDQwLjMzNUMyNS41NTcyIDM5LjEyNSAyNC4zNjU2IDM4LjMxODMgMjMuMDgyMiAzNy45MTVDMjEuODM1NiAzNy41MTE3IDIwLjQ5NzIgMzcuMzEgMTkuMDY3MiAzNy4zMUMxNy41MjcyIDM3LjMxIDE2LjA3ODkgMzcuNjAzMyAxNC43MjIyIDM4LjE5QzEzLjM2NTYgMzguNzQgMTIuMTczOSAzOS41ODMzIDExLjE0NzIgNDAuNzJDMTAuMTU3MiA0MS44NTY3IDkuMzY4ODkgNDMuMjY4MyA4Ljc4MjIzIDQ0Ljk1NUM4LjIzMjIzIDQ2LjY0MTcgNy45NTcyMyA0OC41ODUgNy45NTcyMyA1MC43ODVDNy45NTcyMyA1Mi45MTE3IDguMjUwNTYgNTQuODE4MyA4LjgzNzIzIDU2LjUwNUM5LjQyMzg5IDU4LjE5MTcgMTAuMjEyMiA1OS42NCAxMS4yMDIyIDYwLjg1QzEyLjIyODkgNjIuMDIzMyAxMy40MjA2IDYyLjk0IDE0Ljc3NzIgNjMuNkMxNi4xMzM5IDY0LjIyMzMgMTcuNTgyMiA2NC41MzUgMTkuMTIyMiA2NC41MzVDMjAuMjIyMiA2NC41MzUgMjEuMzAzOSA2NC4zODgzIDIyLjM2NzIgNjQuMDk1QzIzLjQzMDYgNjMuNzY1IDI0LjQyMDYgNjMuMjg4MyAyNS4zMzcyIDYyLjY2NUMyNi4yNTM5IDYyLjA0MTcgMjcuMDA1NiA2MS4zMDgzIDI3LjU5MjIgNjAuNDY1TDMxLjA1NzIgNjIuOTRDMjkuNzAwNiA2NC44NDY3IDI4LjA2ODkgNjYuMjU4MyAyNi4xNjIyIDY3LjE3NUMyNC4yNTU2IDY4LjA5MTcgMjEuOTQ1NiA2OC41NSAxOS4yMzIyIDY4LjU1Wk0zNi4wNDA3IDY4VjMzLjczNUg0MC4xNjU3TDUwLjAxMDcgNTAuMjM1TDYwLjA3NTcgMzMuNjhINjQuMDkwN1Y2OEg1OS41MjU3VjQyLjM3TDUwLjgzNTcgNTYuMTJINDguNjkwN0w0MC41NTA3IDQyLjUzNVY2OEgzNi4wNDA3Wk02OS44NDQzIDY4LjA1NVYzMy43MzVINzkuNjg5M0M4Mi4wNzI2IDMzLjczNSA4NC4wNzA5IDMzLjkxODMgODUuNjg0MyAzNC4yODVDODcuMjk3NiAzNC42NTE3IDg4LjY3MjYgMzUuMTgzMyA4OS44MDkzIDM1Ljg4QzkwLjk4MjYgMzYuNTc2NyA5Mi4wMDkzIDM3LjQzODMgOTIuODg5MyAzOC40NjVDOTMuODA1OSAzOS40OTE3IDk0LjU3NTkgNDAuNjQ2NyA5NS4xOTkzIDQxLjkzQzk1LjgyMjYgNDMuMjEzMyA5Ni4yODA5IDQ0LjYwNjcgOTYuNTc0MyA0Ni4xMUM5Ni45MDQzIDQ3LjYxMzMgOTcuMDY5MyA0OS4yNjMzIDk3LjA2OTMgNTEuMDZDOTYuOTk1OSA1My43IDk2LjU5MjYgNTYuMDY1IDk1Ljg1OTMgNTguMTU1Qzk1LjE2MjYgNjAuMjQ1IDk0LjA5OTMgNjIuMDIzMyA5Mi42NjkzIDYzLjQ5QzkxLjIzOTMgNjQuOTU2NyA4OS4zODc2IDY2LjA5MzMgODcuMTE0MyA2Ni45Qzg0Ljg0MDkgNjcuNjcgODIuMDkwOSA2OC4wNTUgNzguODY0MyA2OC4wNTVINjkuODQ0M1pNNzQuNTE5MyA2NC4yNkg3OC42OTkzQzgxLjg1MjYgNjQuMjYgODQuNDE5MyA2My43NjUgODYuMzk5MyA2Mi43NzVDODguNDE1OSA2MS43NDgzIDg5LjkwMDkgNjAuMjYzMyA5MC44NTQzIDU4LjMyQzkxLjgwNzYgNTYuMzc2NyA5Mi4yODQzIDU0LjAzIDkyLjI4NDMgNTEuMjhDOTIuMjQ3NiA0OC40MiA5MS43ODkzIDQ1Ljk4MTcgOTAuOTA5MyA0My45NjVDOTAuMDI5MyA0MS45NDgzIDg4LjYzNTkgNDAuNDA4MyA4Ni43MjkzIDM5LjM0NUM4NC44NTkzIDM4LjI0NSA4Mi40MjA5IDM3LjY5NSA3OS40MTQzIDM3LjY5NUg3NC41MTkzVjY0LjI2WiIgZmlsbD0id2hpdGUiLz4KPC9zdmc%2BCg%3D%3D&name=1&pattern=Floating%20Cogs&pulls=1&stargazers=1&theme=Auto)
> A simple utility program to simplify your workflow
> A simple utility program to simplify your workflow by executing scripts through the clipboard.
## 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 output of the specified macro script.\
ClipCMD uses [PowerShell](https://learn.microsoft.com/en-us/powershell/scripting) as scripting language.
ClipCMD is an app that allows you to create commands and run them by copying them to the clipboard.\
You can write a command anywhere, copy it to your clipboard, and it will be automatically replaced by the output of the specified command script.\
ClipCMD uses [PowerShell](https://learn.microsoft.com/en-us/powershell/scripting) as the scripting language.
### Example
## Usage
1. Download & install the latest release
- Microsoft Store: [Store Page](https://www.microsoft.com/store/productId/9NZ7PCLGPBW5)
- GitHub: [Releases](https://github.com/Stone-Red-Code/ClipCMD/releases)
1. (Optional) Put a shortcut to the `ClipCMD.Desktop.exe` file in the installation directory into the `shell:startup` directory.
1. Start the app and add a new command.
1. Press the script button to edit the command script.
1. Open an editor and type `<prefix><commandName><suffix>`.
1. Copy the command to the clipboard.
1. Whatever the script outputs should now be pasted into the editor.
## Follow the development
[![Twitter(X)](http://img.shields.io/badge/Twitter-black.svg?&logo=x&style=for-the-badge&logoColor=white)](https://x.com/search?q=from%3A%40StoneRedCode%20%23ClipCMD)
## Example
> Prefix: `_`\
> Suffix: `_`\
> Macro name: `email`\
> Macro script: `Write-Output [email protected]`\
> Macro script (alternative): `"[email protected]"`
> Command name: `email`\
> Command script: `Write-Output [email protected]`\
> Command script (alternative): `"[email protected]"`\
> Input: `_email_`\
> Output: `[email protected]`
## Usage
1. Download one of the [releases](https://github.com/Stone-Red-Code/ClipCMD/releases) directly from GitHub or download it with [HyperbolicDownloader](https://github.com/Stone-Red-Code/HyperbolicDownloader)
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:
```
[<command name(s) (separated by comma)>]
<scriptText>
<scriptText>
<scriptText>
...
[<command name(s) (separated by comma)>]
<scriptText>
<scriptText>
<scriptText>
...
```
- 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
<img width="591" alt="image" src="https://user-images.githubusercontent.com/56473591/226146460-d9d2e8fc-3754-44c7-bc43-2e32f1d07847.png">
## Third party licences
- [InputSimulator](https://github.com/michaelnoonan/inputsimulator) - [MIT](https://github.com/michaelnoonan/inputsimulator/blob/master/LICENSE)
- [Avalonia](https://github.com/AvaloniaUI/Avalonia) - [MIT](https://github.com/AvaloniaUI/Avalonia/blob/master/licence.md)
- [Icons.Avalonia](https://github.com/Projektanker/Icons.Avalonia) - [MIT](https://github.com/Projektanker/Icons.Avalonia/blob/main/LICENSE)
- [Semi.Avalonia](https://github.com/irihitech/Semi.Avalonia) - [MIT](https://github.com/irihitech/Semi.Avalonia/blob/main/LICENSE)
- [SharpHook](https://github.com/TolikPylypchuk/SharpHook) - [MIT](https://github.com/TolikPylypchuk/SharpHook/blob/main/LICENSE)