Skip to content

Commit f60a83e

Browse files
Sync README to index.md
1 parent f901040 commit f60a83e

File tree

1 file changed

+113
-0
lines changed

1 file changed

+113
-0
lines changed

index.md

Lines changed: 113 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,113 @@
1+
# WINDOWS-AHK
2+
3+
A simple and intuitive AutoHotKey script designed to enhance Windows shortcuts and improve your workflow.
4+
5+
[![GitHub License](https://img.shields.io/github/license/arlbibek/windows-ahk)](https://github.com/arlbibek/windows-ahk/blob/master/LICENSE)
6+
[![GitHub release](https://img.shields.io/github/v/release/arlbibek/windows-ahk)](https://github.com/arlbibek/windows-ahk/releases/latest)
7+
[![GitHub all releases](https://img.shields.io/github/downloads/arlbibek/windows-ahk/total)](https://github.com/arlbibek/windows-ahk/releases/latest)
8+
[![GitHub Stars](https://img.shields.io/github/stars/arlbibek/windows-ahk?style=social)](https://github.com/arlbibek/windows-ahk/stargazers)
9+
[![GitHub Forks](https://img.shields.io/github/forks/arlbibek/windows-ahk?style=social)](https://github.com/arlbibek/windows-ahk/network/members)
10+
[![GitHub Issues](https://img.shields.io/github/issues/arlbibek/windows-ahk)](https://github.com/arlbibek/windows-ahk/issues)
11+
[![Last Commit](https://img.shields.io/github/last-commit/arlbibek/windows-ahk)](https://github.com/arlbibek/windows-ahk/commits/main)
12+
[![Repo Size](https://img.shields.io/github/repo-size/arlbibek/windows-ahk)](https://github.com/arlbibek/windows-ahk)
13+
14+
<img src="https://raw.githubusercontent.com/arlbibek/windows-ahk/master/assets/windows-ahk.png" width="200" />
15+
16+
Do you often find yourself repeating small, tedious tasks — like switching between apps, copying text, pasting it into a browser to search, checking the calendar just to type today’s date, changing text cases, or typing the same responses over and over? This script attempts to eliminate those micro-frustrations by automating repetitive actions.
17+
18+
## 🚀 Features
19+
20+
Here are some of the features WINDOWS-AHK offers:
21+
22+
- 🔄 Application switcher: Launch or toggle between apps using function keys (customizable).
23+
- 📁 File Explorer power-shortcuts: Instantly Open file explorer or navigate to folders like Downloads, Music, or open VS Code in the current directory.
24+
- 🧠 Hotstrings & snippets: Type /date, /addr, etc., to expand text dynamically.
25+
- 🔤 Text case transformers: Change selected text to uppercase, lowercase, or title case instantly.
26+
- 🔍 Quick search: Search any selected text directly in your browser.
27+
- 🖥️ Presentation mode: Toggle Windows Presentation Mode on/off.
28+
- 🧩 Customizable: Change actions, hotkeys, and text expansions via configuration file — no code needed!
29+
30+
<details style="border: 1px solid #ccc; border-radius: 5px; padding: 10px; margin-bottom: 10px;">
31+
<summary style="font-weight: bold; cursor: pointer; outline: none;">
32+
Learn more about AutoHotKey
33+
</summary>
34+
AutoHotkey is a free and open-source scripting language for Windows, originally designed to create custom keyboard shortcuts, automate tasks, and perform fast macro-creation. It empowers users of all skill levels to automate repetitive tasks in Windows applications.
35+
36+
- Official Website: [autohotkey.com](https://www.autohotkey.com)
37+
- Download AutoHotkey: [autohotkey.com/download](https://www.autohotkey.com/download)
38+
39+
</details>
40+
41+
## 📖 Usage
42+
43+
```plaintext
44+
CAUTION! ⚠️
45+
THESE SCRIPTS TEND TO BE VERY ADDICTIVE.
46+
```
47+
48+
### Option 1
49+
50+
_Recommended_
51+
52+
1. Download the `WINDOWS_AHK.exe` from the latest [releases](https://github.com/arlbibek/windows-ahk/releases).
53+
2. Run the `WINDOWS_AHK.exe` file. Done!
54+
55+
> **Please note:** You are likely to encounter a **Windows SmartScreen warning** when launching `windows_ahk.exe` for the first time.
56+
> This is a common behavior for executables that aren't digitally signed or widely downloaded.
57+
>
58+
> To proceed: Click **"More info"** on the warning screen. Then click **"Run anyway"**.
59+
60+
### Option 2
61+
62+
☑️ _Ideal for users who prefer not to run `.exe` files or want to tweak the script_
63+
64+
1. Download and install AutoHotKey v2 from [autohotkey.com/download](https://www.autohotkey.com/download).
65+
2. Clone this repository and navigate to the `windows-ahk/` directory.
66+
3. Run the `WINDOWS.ahk` script. That’s it!
67+
68+
## ⌨️ Keyboard Shortcuts
69+
70+
Explore the available keyboard shortcuts in [keyboardshortcuts.md](https://github.com/arlbibek/windows-ahk/blob/master/keyboardshortcuts.md) or download the [keyboardshortcuts.pdf](https://github.com/arlbibek/windows-ahk/blob/master/keyboardshortcuts.pdf).
71+
72+
## 🛠️ Customize Your Experience
73+
74+
You can personalize the script by editing `config.ini` (for function key behaviors and hotstrings). To do so after launching the script:
75+
76+
1. Right-click the tray icon → **Launch configuration window**
77+
2. Click **Open configuration file**,
78+
3. Edit as needed, guidelines can be found on the config file itself or in [keyboardshortcuts.md](https://github.com/arlbibek/windows-ahk/blob/master/keyboardshortcuts.md)
79+
4. Save changes and reload the script
80+
81+
## 📂 Project Structure
82+
83+
- `WINDOWS.ahk` – Main script
84+
- `assets/` – Icons, screenshots, and media
85+
- `keyboardshortcuts.md` – Keyboard shortcuts documentation
86+
- `keyboardshortcuts.pdf` – PDF version of shortcuts
87+
- `config.ini` – User configuration (generated after first run)
88+
89+
## 🔗 Additional Resources
90+
91+
- 🔍 [AutoHotKey Documentation](https://www.autohotkey.com/docs/v2/)
92+
- 📜 [AutoHotkey Script Showcase](https://www.autohotkey.com/docs/scripts/index.htm) – Discover scripts created by different authors that showcase AutoHotkey's capabilities.
93+
- 🛠️ [Skrommel's One Hour Software](https://www.dcmembers.com/skrommel/downloads/) – More useful scripts and utilities.
94+
- 📄 [md2pdf](https://github.com/realdennis/md2pdf) by [@realdennis](https://github.com/realdennis/) - Offline markdown to PDF converter.
95+
96+
## 💬 Join us on Discord
97+
98+
at [discord.gg/a2NyrV6PBY](http://discord.gg/a2NyrV6PBY) to connect with other Windows AHK users and get support.
99+
100+
[![Join our Discord server!](https://invidget.switchblade.xyz/a2NyrV6PBY)](http://discord.gg/a2NyrV6PBY)
101+
102+
## 📜 License
103+
104+
Copyleft (ↄ) 2025 Bibek Aryal
105+
106+
This project is licensed under the GNU General Public License v3.0 (GPLv3).
107+
You are free to use, modify, and distribute the code under the terms of this license.
108+
109+
See the [LICENSE](https://github.com/arlbibek/windows-ahk/blob/master/LICENSE) file for full details.
110+
111+
---
112+
113+
Made with ❤️ by [Bibek Aryal](https://bibeka.com.np/).

0 commit comments

Comments
 (0)