diff --git a/README.md b/README.md new file mode 100644 index 0000000..32d81db --- /dev/null +++ b/README.md @@ -0,0 +1,60 @@ +# Snippy + +Snippy is a linux snippet manager with powerfull features ! + +![snippy](img/snippy.png) + +## Features + +### Clipboard + +* Restore current clipboard after pasting the snippet +* `{clipboard}` placeholder to use current clipboard in snippet +``` +CREATE DATABASE \`{clipboard}\` CHARACTER SET utf8 COLLATE utf8_general_ci; +``` + +### Cursor + +`{cursor}` placeholder to place the cursor + +* go left to the correct position for cli and gui paste + ``` +
{cursor}
+ ``` + +* go up for block snippet for gui paste + ``` +
+    {cursor}
+  
+ ``` + +### Parsing +* `##noparse` header in snippet to not parse/execute the snippet. + ``` + ##noparse + date --date="$(date +%F) -1 month" +%F + ``` +* directly execute command begining by `$` +* execute bash script in `$snippets_directory/scripts` +* copy script content when selection is selected by CTRL+Return, exemple: + - with the following snippet: `$(date +%Y-%m-%d-%Hh%Mm%S)` + - using Return will paste the current date + - using CTRL+Return will paste the command directly + + +### Icons ! + +Icon name is set in rofi with the root directory name of your snippets. + +If you have the following snippets, the `terminal` icon will be displayed in rofi: +``` + terminal/ + ├── other/ + │   └── date + └── script/ + └── test +``` + +![icons](img/icons.png) diff --git a/img/icons.png b/img/icons.png new file mode 100644 index 0000000..0cd6b79 Binary files /dev/null and b/img/icons.png differ diff --git a/img/snippy.png b/img/snippy.png new file mode 100644 index 0000000..03628a2 Binary files /dev/null and b/img/snippy.png differ