Skip to content

Commit 4e7afb5

Browse files
committed
Initial Code Upload. V1.0
1 parent 85b780b commit 4e7afb5

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+1284
-1
lines changed

README.md

Lines changed: 75 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,75 @@
1-
snips
1+
# Snips v1.0
2+
A simple way to store and use text snippets in any windows program.
3+
https://github.com/ethanpil/snips
4+
5+
[Download Binary](https://github.com/ethanpil/snips/releases)
6+
7+
## Instructions
8+
9+
* Activate Snips using the hotkey - Default is CTRL+` (CTRL+Backtick)
10+
* By default the search box is activated, so you can tyoe to search snippet titles. (File names)
11+
* Hit the down arrow to activate the tree or search resuls box. Use the arrow keys to navigate
12+
* Press enter or double click to copy a snippet to clipboard
13+
* Escape key will close Snips and return you to your previous window
14+
* CTRL+R will refresh your list of snippets from disk
15+
* A tray icon is displayed, which you can use to manage Snips or terminate the program.
16+
17+
All snippets are plain text files stored in the \snips folder under the program binary. One snippet per file.
18+
19+
### History
20+
21+
````
22+
23+
v1.0 - Initial Release
24+
25+
````
26+
27+
## Why
28+
29+
I made this because:
30+
31+
* I want to use the same snippet list across all my editors and IDE software
32+
* I want an easy and intuitive way to manage my snippets
33+
* I dont want my snippets in a proprietary format
34+
* Other third party snippet tools were too bulky and resource intensive
35+
* It was fun
36+
37+
38+
## Options
39+
40+
Snips.ini the the program folder sets a few options:
41+
42+
folder=snips ; The subfolder under snips.exe which contains all the snippets.
43+
key=^` ; An autohotkey code that activates the snippets window.
44+
45+
## Snippet Files
46+
47+
All snippets are plain text files stored in the \snips folder under the program binary. One snippet per file. Edit the contents of the \snips folder in the program root to modify your collection. The tree view will mirror your folder structure. Filenames are the Snippet titles displayed in search and tree.
48+
49+
## Position the Cursor
50+
51+
You can tell Snips to position the cursor with anoptional command code exclusively on the last line of a snippet file: <<-X
52+
Replace X with the number of spaces FROM THE END OF THE FILE to reverse the cursor.
53+
54+
For example if your snippet file contained the following code:
55+
56+
#include <>
57+
<<-2
58+
59+
The <<-2 on the last line of the file tells snips to position the cursor 2 characters from the end of the previous line. Therefore, after the snippet is inserted, the cursor will be positioned between the brackets. <|>.
60+
61+
## Default Snippets
62+
63+
I have included some basics to get you started. Please feel free to share any useful default snippets you think other users will appreciate. I prefer a PR on GitHub for your submissions.
64+
65+
## Warranty and Support
66+
67+
None provided. Good luck. Source code is available on GitHub.
68+
69+
## Thanks
70+
71+
[AutoHotKey](https://autohotkey.com/) developers and forums.
72+
73+
## License and Copyright
74+
Copyright (C) Ethan Piliavin
75+
Released under the [GPLv3 license](https://www.gnu.org/licenses/gpl-3.0.en.html), included as license.txt

license.txt

Lines changed: 674 additions & 0 deletions
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)