Skip to content

Commit 1ba9dad

Browse files
committed
Update README with information about update scripts
1 parent d69f330 commit 1ba9dad

1 file changed

Lines changed: 18 additions & 2 deletions

File tree

README.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,25 @@ This repository contains a collection of custom rules for the Cursor IDE to help
44

55
## How to Use
66

7+
### First-Time Installation
8+
79
1. Clone this repository or download the `.mdc` files
8-
2. Create a `.cursor/rules` folder in your project if it doesn't exist
9-
3. Copy the desired `.mdc` files to your project's `.cursor/rules` folder
10+
2. Run the installation script:
11+
- Windows: `.\install.ps1`
12+
- Mac/Linux: `chmod +x install.sh && ./install.sh`
13+
14+
Alternatively, you can manually create a `.cursor/rules` folder in your project and copy the desired `.mdc` files.
15+
16+
### Updating Existing Rules
17+
18+
If you've already installed these rules and want to update to the latest version:
19+
20+
1. Pull the latest changes or download the latest release
21+
2. Run the update script:
22+
- Windows: `.\update.ps1`
23+
- Mac/Linux: `chmod +x update.sh && ./update.sh`
24+
25+
The update script will only replace rules that have changed and add new ones, preserving any custom rules you may have created.
1026

1127
## Available Rules
1228

0 commit comments

Comments
 (0)